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]>
This commit is contained in:
@@ -31,12 +31,17 @@ echo "Price $49.99, SKU ABC-123" | json-extract --fields "price, sku"
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Install
|
||||
pip install smarttools
|
||||
# Clone and install
|
||||
git clone https://gitea.brrd.tech/rob/SmartTools.git
|
||||
cd SmartTools
|
||||
pip install -e .
|
||||
|
||||
# Ensure ~/.local/bin is in PATH
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
|
||||
# Install an AI provider (interactive guide)
|
||||
smarttools providers install
|
||||
|
||||
# Launch the UI
|
||||
smarttools ui
|
||||
|
||||
@@ -46,18 +51,20 @@ smarttools create summarize
|
||||
|
||||
## Installation
|
||||
|
||||
### From PyPI (Recommended)
|
||||
### Native Install
|
||||
|
||||
```bash
|
||||
pip install smarttools
|
||||
git clone https://gitea.brrd.tech/rob/SmartTools.git
|
||||
cd SmartTools
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
### From Source
|
||||
### With Development Dependencies
|
||||
|
||||
```bash
|
||||
git clone https://gitea.brrd.tech/rob/smarttools.git
|
||||
cd smarttools
|
||||
pip install -e .
|
||||
git clone https://gitea.brrd.tech/rob/SmartTools.git
|
||||
cd SmartTools
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
### Requirements
|
||||
@@ -229,10 +236,9 @@ SmartTools comes with 28 pre-built examples you can install:
|
||||
### Install Example Tools
|
||||
|
||||
```bash
|
||||
# Download and run the example installer
|
||||
curl -sSL https://gitea.brrd.tech/rob/smarttools/raw/branch/main/examples/install.py | python3
|
||||
|
||||
# Or manually copy from examples/
|
||||
# Run the example installer (from the SmartTools directory)
|
||||
python examples/install.py
|
||||
smarttools refresh
|
||||
```
|
||||
|
||||
## Providers
|
||||
@@ -435,7 +441,7 @@ MIT - Use it, modify it, share it.
|
||||
|
||||
## Docker
|
||||
|
||||
Run SmartTools without installing anything locally:
|
||||
Run SmartTools in a container:
|
||||
|
||||
```bash
|
||||
# Clone the repo
|
||||
@@ -455,6 +461,38 @@ docker-compose run --rm cli smarttools list
|
||||
docker-compose run --rm shell
|
||||
```
|
||||
|
||||
### Installing AI Providers in Docker
|
||||
|
||||
AI providers require browser-based authentication. Use the `setup` service which has display access:
|
||||
|
||||
```bash
|
||||
# Allow Docker to access your display (Linux)
|
||||
xhost +local:docker
|
||||
|
||||
# Start the setup container
|
||||
docker-compose run --rm setup
|
||||
|
||||
# Inside the container, use the interactive installer:
|
||||
smarttools providers install
|
||||
|
||||
# Select a provider (1-5), it will:
|
||||
# - Install the CLI tool
|
||||
# - Open a browser for sign-in
|
||||
# - Configure the provider
|
||||
|
||||
# After signing in, test it:
|
||||
smarttools providers test claude
|
||||
```
|
||||
|
||||
**Available Providers:**
|
||||
| # | Provider | Cost | Notes |
|
||||
|---|----------|------|-------|
|
||||
| 1 | Claude | Pay-per-use | Anthropic account |
|
||||
| 2 | Codex | Pay-per-use | OpenAI account |
|
||||
| 3 | Gemini | Free tier | Google account |
|
||||
| 4 | OpenCode | Free tier | Multiple models |
|
||||
| 5 | Ollama | FREE | Local, no internet |
|
||||
|
||||
## Links
|
||||
|
||||
- [Installation Guide](docs/INSTALL.md)
|
||||
|
||||
Reference in New Issue
Block a user