8000 Improve CLI command documentation format in README by ddkang1 · Pull Request #8 · ddkang1/smart-agent · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Improve CLI command documentation format in README #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 2, 2025
Merged

Improve CLI command documentation format in README #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For development or quick testing, run Smart Agent with tools managed automatical
pip install smart-agent

# Run the interactive setup wizard
smart-agent setup # Walks you through configuration options
smart-agent setup [--quick] # Setup with optional quick mode

# Start chat (will automatically launch required tools)
smart-agent chat
Expand All @@ -69,11 +69,7 @@ For development when you need tools to stay running between chat sessions:

```bash
# Terminal 1: First setup your configuration
smart-agent setup # Interactive wizard for configuration
smart-agent setup --quick # Quick setup: copy example files without prompts
smart-agent setup --config # Configure only config.yaml
smart-agent setup --tools # Configure only tools.yaml
smart-agent setup --litellm # Configure only litellm_config.yaml
smart-agent setup [--quick|--config|--tools|--litellm] # Setup with various options

# Then launch tools and proxy services that keep running
smart-agent start --all # Use --tools or --proxy to start specific services
Expand All @@ -94,7 +90,7 @@ Connect to remote tool services running elsewhere (e.g., in production):

```bash
# Create configuration through the interactive wizard
smart-agent setup # Walks you through configuration options
smart-agent setup [--quick] # Setup with optional quick mode

# Edit config/tools.yaml to use remote URLs
# Example: url: "https://production-server.example.com/tool-name/sse"
Expand Down Expand Up @@ -282,7 +278,7 @@ The Smart Agent CLI provides commands to help manage these configuration files:

```bash
# Run the setup wizard to create configuration files
smart-agent setup
smart-agent setup [--quick|--config|--tools|--litellm]
```

The setup wizard will guide you through creating configuration files based on examples.
Expand All @@ -304,6 +300,9 @@ source venv/bin/activate # On Windows: venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

# Run the setup wizard to create configuration files
smart-agent setup [--quick] # Setup with optional quick mode
```

### Running Tests
Expand Down
0