Skip to content

Commit 418348a

Browse files
committed
Add: pre built binaries docs
1 parent e3babc0 commit 418348a

File tree

2 files changed

+96
-3
lines changed

2 files changed

+96
-3
lines changed

README.md

Lines changed: 95 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The `ipgeolocation` CLI lets you interact with the [ipgeolocation.io](https://ip
3333

3434
To install `ipgeolocation` using `go install`, run:
3535
```bash
36-
go install github.com/IPGeolocation/cli@latest
36+
go install github.com/IPGeolocation/cli/cmd/ipgeolocation@latest
3737
```
3838

3939
Make sure `$GOBIN` or `$GOPATH/bin` is in your `PATH`, then run:
@@ -47,10 +47,103 @@ ipgeolocation --help
4747
```bash
4848
git clone https://github.com/IPGeolocation/cli.git
4949
cd cli
50-
go build -o ipgeolocation .
50+
go build -o ipgeolocation ./cmd/ipgeolocation
5151
./ipgeolocation --help
5252
```
5353

54+
### 3. Download pre-built binaries
55+
56+
#### IPGeolocation CLI - Prebuilt Binaries Documentation
57+
58+
#### Overview
59+
These are prebuilt binaries for the IPGeolocation CLI tool, version **1.0.0**. Users can download these files directly from GitHub Releases without needing to build from source.
60+
61+
The CLI provides geolocation information, timezone, user-agent parsing, bulk IP lookups, and more.
62+
63+
---
64+
65+
#### Prebuilt Binaries
66+
67+
| Platform | Architecture | File Name |
68+
|----------|-------------|-----------|
69+
| Linux | amd64 | ipgeolocation-1.0.0-linux-amd64.tar.gz |
70+
| Linux | arm64 | ipgeolocation-1.0.0-linux-arm64.tar.gz |
71+
| macOS | amd64 | ipgeolocation-1.0.0-darwin-amd64.tar.gz |
72+
| macOS | arm64 | ipgeolocation-1.0.0-darwin-arm64.tar.gz |
73+
| Windows | amd64 | ipgeolocation-1.0.0-windows-amd64.zip |
74+
75+
---
76+
77+
#### Installation Instructions
78+
79+
##### 1. Linux
80+
1. Download the `.tar.gz` file for your architecture.
81+
2. Extract it to a folder in your PATH, e.g., `/usr/local/bin`:
82+
```bash
83+
tar -xzf ipgeolocation-1.0.0-linux-amd64.tar.gz -C /usr/local/bin
84+
```
85+
3. Rename the binary for simplicity:
86+
```bash
87+
mv /usr/local/bin/ipgeolocation-1.0.0-linux-amd64 /usr/local/bin/ipgeolocation
88+
```
89+
4. Make the binary executable:
90+
```bash
91+
chmod +x /usr/local/bin/ipgeolocation
92+
```
93+
5. Verify installation:
94+
```bash
95+
ipgeolocation --help
96+
```
97+
98+
##### 2. macOS
99+
1. Download the `.tar.gz` file for your architecture (amd64 or arm64).
100+
2. Extract to a folder in your PATH, e.g., `/usr/local/bin`:
101+
```bash
102+
tar -xzf ipgeolocation-1.0.0-darwin-amd64.tar.gz -C /usr/local/bin
103+
```
104+
3. Rename the binary:
105+
```bash
106+
mv /usr/local/bin/ipgeolocation-1.0.0-darwin-amd64 /usr/local/bin/ipgeolocation
107+
```
108+
4. Make executable:
109+
```bash
110+
chmod +x /usr/local/bin/ipgeolocation
111+
```
112+
5. Verify installation:
113+
```bash
114+
ipgeolocation --help
115+
```
116+
117+
##### 3. Windows
118+
1. Download the `.zip` file.
119+
2. Extract the `ipgeolocation-1.0.0-windows-amd64.exe` to a folder included in your system `PATH`.
120+
3. Rename the binary to `ipgeolocation.exe` for convenience.
121+
4. Open Command Prompt and verify:
122+
```cmd
123+
ipgeolocation --help
124+
```
125+
126+
---
127+
128+
##### Notes
129+
- Ensure execution permissions on Linux/macOS.
130+
- Recommended folder for binaries: `/usr/local/bin` or any folder in your PATH.
131+
- Prebuilt binaries include version **1.0.0** in their filename. Rename them after extraction for easier usage.
132+
- For updates, check GitHub Releases.
133+
- Users can also install via Go if Go environment is set up:
134+
```bash
135+
go install github.com/IPGeolocation/cli/cmd/[email protected]
136+
```
137+
138+
---
139+
140+
##### Troubleshooting
141+
- **Command not found:** Ensure the binary is in a folder included in your PATH.
142+
- **Execution permission error:** Run `chmod +x <binary>` on Linux/macOS.
143+
- **Wrong architecture:** Download the binary matching your OS and CPU architecture.
144+
- **Go install issues:** Use `GOPROXY=direct` if Go module proxy caching creates issues.
145+
146+
54147
## Global Flags
55148
These flags are available for all commands:
56149

build-release.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ for target in "${targets[@]}"; do
2828
fi
2929

3030
echo "👉 Building for $os/$arch ..."
31-
GOOS=$os GOARCH=$arch go build -o dist/$output .
31+
GOOS=$os GOARCH=$arch go build -o dist/$output ./cmd/$APP_NAME
3232

3333
# package
3434
if [ "$os" == "windows" ]; then

0 commit comments

Comments
 (0)