Add interactive provider installer and fix documentation

- Add `smarttools providers install` interactive guide for installing AI CLIs - Fix OpenCode install URL (remove .sh suffix) - Auto-refresh PATH after provider installation - Fix incorrect npm package names in docs: - @anthropic-ai/claude-code (not claude-cli) - @openai/codex (not codex-cli) - @google/gemini-cli (not @anthropic-ai/gemini-cli) - Update all docs to reflect clone-first install workflow (not PyPI) - Add Docker provider installation section to README 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
2025-12-29 17:33:23 -04:00
parent b09008c215
commit 543ded0a5f
5 changed files with 164 additions and 70 deletions
@@ -5,8 +5,8 @@ This document contains all 28 pre-built SmartTools with their full configuration
 ## Quick Install

 ```bash
-# Install all example tools
-curl -sSL https://gitea.brrd.tech/rob/smarttools/raw/branch/main/examples/install.py | python3
+# Install all example tools (from the SmartTools directory)
+python examples/install.py
 smarttools refresh
 ```

@@ -5,9 +5,11 @@ Complete installation instructions for SmartTools.
 ## Quick Install

 ```bash
-pip install smarttools
+git clone https://gitea.brrd.tech/rob/SmartTools.git
+cd SmartTools
+pip install -e .
 export PATH="$HOME/.local/bin:$PATH"
-smarttools refresh
+smarttools providers install
 ```

 ## Detailed Installation
@@ -32,21 +34,15 @@ python3 --version  # Should be 3.10 or higher

 ### Step 2: Install SmartTools

-**From PyPI (recommended):**
 ```bash
-pip install smarttools
-```
-
-**From source (for development):**
-```bash
-git clone https://gitea.brrd.tech/rob/smarttools.git
-cd smarttools
+git clone https://gitea.brrd.tech/rob/SmartTools.git
+cd SmartTools
 pip install -e .
 ```

-**With TUI support (recommended):**
+**With TUI and development dependencies:**
 ```bash
-pip install smarttools urwid
+pip install -e ".[dev]"
 ```

 ### Step 3: Configure PATH
@@ -75,43 +71,46 @@ source ~/.bashrc  # or restart terminal

 ### Step 4: Install an AI Provider

-You need at least one AI CLI tool. Choose based on your needs:
+You need at least one AI CLI tool. The easiest way is the interactive installer:

-#### Free Options
-
-**OpenCode (recommended for free):**
 ```bash
-# Install
+smarttools providers install
+```
+
+This guides you through installing and authenticating providers.
+
+#### Manual Installation
+
+**OpenCode (free tier available):**
+```bash
 curl -fsSL https://opencode.ai/install | bash
-
-# Authenticate (uses browser)
-~/.opencode/bin/opencode auth
+source ~/.bashrc  # or start new shell
+opencode  # Opens browser for sign-in
 ```

-#### Paid Options
-
-**Claude CLI:**
+**Claude CLI (pay-per-use):**
 ```bash
-# Install
-npm install -g @anthropic-ai/claude-cli
-
-# Authenticate
-claude auth
+npm install -g @anthropic-ai/claude-code
+claude  # Opens browser for sign-in
 ```

-**Gemini CLI:**
+**Codex (pay-per-use):**
 ```bash
-# Install
-pip install google-generativeai
-
-# Or the CLI wrapper
-npm install -g @anthropic-ai/gemini-cli
+npm install -g @openai/codex
+codex  # Opens browser for sign-in
 ```

-**Codex (OpenAI):**
+**Gemini (free tier available):**
 ```bash
-npm install -g codex-cli
-codex auth
+npm install -g @google/gemini-cli
+gemini  # Opens browser for Google sign-in
+```
+
+**Ollama (free, runs locally):**
+```bash
+curl -fsSL https://ollama.ai/install.sh | bash
+ollama pull llama3
+smarttools providers add ollama "ollama run llama3" -d "Local Llama 3"
 ```

 See [PROVIDERS.md](PROVIDERS.md) for full provider setup instructions.
@@ -122,8 +121,11 @@ See [PROVIDERS.md](PROVIDERS.md) for full provider setup instructions.
 # Check SmartTools is installed
 smarttools --version

-# List available providers
-smarttools providers
+# List configured providers
+smarttools providers list
+
+# Check which providers are available
+smarttools providers check

 # Test with mock provider (no AI needed)
 echo "hello world" | smarttools run --provider mock
@@ -144,7 +146,7 @@ This creates executable scripts in `~/.local/bin/` for all your tools.
 ### Quick Install (All 28 Tools)

 ```bash
-curl -sSL https://raw.githubusercontent.com/yourusername/smarttools/main/examples/install.py | python3
+python examples/install.py
 smarttools refresh
 ```

@@ -65,14 +65,12 @@ Anthropic's official CLI for Claude models.

 **Install:**
 ```bash
-npm install -g @anthropic-ai/claude-cli
-# or
-brew install claude
+npm install -g @anthropic-ai/claude-code
 ```

 **Authenticate:**
 ```bash
-claude auth
+claude  # Opens browser for sign-in (auto-saves auth tokens)
 ```

 **Available Models:**
@@ -94,12 +92,12 @@ OpenAI's Codex CLI with auto-routing.

 **Install:**
 ```bash
-npm install -g codex-cli
+npm install -g @openai/codex
 ```

 **Authenticate:**
 ```bash
-codex auth  # Uses ChatGPT account
+codex  # Opens browser for sign-in (auto-saves auth tokens)
 ```

 **Test:**
@@ -113,14 +111,12 @@ Google's Gemini models. Best for large context (1M tokens).

 **Install:**
 ```bash
-npm install -g @anthropic-ai/gemini-cli
-# or
-pip install google-generativeai
+npm install -g @google/gemini-cli
 ```

 **Authenticate:**
 ```bash
-gemini auth  # Uses Google account
+gemini  # Opens browser for Google sign-in
 ```

 **Available Models:**
@@ -138,16 +134,36 @@ echo "Hello" | gemini --model gemini-2.5-flash

 ## Managing Providers

+### Interactive Installation (Recommended)
+
+The easiest way to install providers:
+
+```bash
+smarttools providers install
+```
+
+This interactive guide:
+- Shows available AI providers with costs
+- Runs the installation command
+- Updates PATH automatically
+- Shows next steps for authentication
+
 ### List Providers

 ```bash
-smarttools providers
+smarttools providers list
+```
+
+### Check Availability
+
+```bash
+smarttools providers check
 ```

 ### Add Custom Provider

 ```bash
-smarttools providers add
+smarttools providers add myname "my-command --args" -d "Description"
 ```

 Or edit `~/.smarttools/providers.yaml`: