Version 1.3: Allow disabling header

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Luke Tainton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Main.go

@@ -7,15 +7,28 @@ import (
 )
 
 func main() {
-	printHeader()
-
 	var input string
 	var wantPrefixes bool
+	var wantHeader bool
+
+	flag.StringVar(&input, "i", "", "IP address or domain")
+	flag.BoolVar(&wantPrefixes, "p", false, "print BGP prefixes")
+	flag.BoolVar(&wantHeader, "b", true, "enable/disable header")
+
+	flag.Usage = func() {
+		fmt.Printf("Usage of iPilot: \n")
+		fmt.Printf("  -b	bool	enable/disable header (default true)\n")
+		fmt.Printf("  -h	bool	view help\n")
+		fmt.Printf("  -i	string	IP address or domain\n")
+		fmt.Printf("  -p	bool	print BGP prefixes (default false)\n")
+	}
 
-	flag.StringVar(&input, "i", "", "Specify IP address or domain name.")
-	flag.BoolVar(&wantPrefixes, "p", false, "Enable printing of advertised BGP prefixes.")
 	flag.Parse()
 
+	if wantHeader {
+		printHeader()
+	}
+
 	if input == "" {
 		fmt.Println("FATAL: No IP address or domain name was specified.")
 		os.Exit(1)

README.md

@@ -0,0 +1,20 @@
+# IP Information Lookup Tool (iPilot)
+
+This Go application takes an IP address or domain name and gathers the following information:
+- Location
+- Timezone
+- Internet Service Provider
+- Autonomous System
+- Advertised Prefixes
+
+## Running the script
+Here are some ways that you can run the script:
+| Command                | Description                              |
+| ---------------------- | ---------------------------------------- |
+| `./iPilot -i me`         | Run against your own connection          |
+| `./iPilot -i 1.1.1.1`    | Run against the IP address `1.1.1.1`     |
+| `./iPilot -i google.com` | Run against the domain name `google.com` |
+| `./iPilot -i google.com -p` | Run against the domain name `google.com` and lists BGP prefixes |
+
+## Credits
+This script runs thanks to the APIs provided by [IP-API](http://ip-api.com) and [HackerTarget](https://hackertarget.com/as-ip-lookup).