Skip to content

Commit 80e5b81

Browse files
docs: πŸ“šοΈ Update README and install script to emphasize configuring AI provider after install
1 parent e9234c7 commit 80e5b81

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,16 @@ curl -fsSL https://raw.githubusercontent.com/abhishekbhardwaj/aish-cli/main/scri
1212

1313
This installs AISH to `~/.local/bin/aish` (following XDG Base Directory specification).
1414

15+
**After installation, configure your AI provider:**
16+
```bash
17+
aish configure # Set up your AI provider and API key first
18+
```
19+
1520
### Install Specific Version
1621

1722
```bash
1823
VERSION=v1.2.3 curl -fsSL https://raw.githubusercontent.com/abhishekbhardwaj/aish-cli/main/scripts/install.sh | bash
24+
# Then configure: aish configure
1925
```
2026

2127
### Manual Installation
@@ -24,6 +30,7 @@ VERSION=v1.2.3 curl -fsSL https://raw.githubusercontent.com/abhishekbhardwaj/ais
2430
2. Extract the archive: `tar -xzf aish-*.tar.gz` (or unzip for Windows)
2531
3. Make executable: `chmod +x aish`
2632
4. Move to PATH: `mv aish ~/.local/bin/` (or `/usr/local/bin/` with sudo)
33+
5. **Configure your AI provider:** `aish configure`
2734

2835
### Build from Source
2936

@@ -32,6 +39,7 @@ git clone https://github.com/abhishekbhardwaj/aish-cli.git
3239
cd aish
3340
bun install
3441
bun run build
42+
# Configure after building: ./aish configure
3543
```
3644

3745
## πŸ“– Commands Reference

β€Žscripts/install.shβ€Ž

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,12 @@ echo
190190
print_message info "πŸŽ‰ ${ORANGE}aish ${GREEN}v${specific_version} installed successfully!"
191191
print_message info "πŸ“ Installed to: ${YELLOW}$INSTALL_DIR/aish"
192192
echo
193-
print_message info "πŸš€ Try it out:"
194-
print_message info " ${YELLOW}aish ask \"What's the weather like?\""
195-
print_message info " ${YELLOW}aish configure"
193+
print_message info "πŸš€ Get started:"
194+
print_message info " ${YELLOW}aish configure ${GREEN}# Configure AI provider first"
195+
echo
196+
print_message info "πŸ’‘ Then try these commands:"
197+
print_message info " ${YELLOW}aish c \"show me disk usage\""
198+
print_message info " ${YELLOW}aish ask \"What's the capital of France?\""
196199
echo
197200
print_message info "πŸ“š To uninstall:"
198201
print_message info " ${YELLOW}rm -f $INSTALL_DIR/aish"

0 commit comments

Comments
Β (0)