You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 lines
2.4 KiB
48 lines
2.4 KiB
# CLI Guides Overview
|
|
|
|
Master the Swarms command-line interface with these step-by-step guides. Execute agents, run multi-agent workflows, and integrate Swarms into your DevOps pipelines—all from your terminal.
|
|
|
|
## What You'll Learn
|
|
|
|
| Topic | Description |
|
|
|-------|-------------|
|
|
| **CLI Basics** | Install, configure, and run your first commands |
|
|
| **Agent Creation** | Create and run agents directly from command line |
|
|
| **YAML Configuration** | Define agents in config files for reproducible deployments |
|
|
| **Multi-Agent Commands** | Run LLM Council and Heavy Swarm from terminal |
|
|
| **DevOps Integration** | Integrate into CI/CD pipelines and scripts |
|
|
|
|
---
|
|
|
|
## CLI Guides
|
|
|
|
| Guide | Description | Link |
|
|
|-------|-------------|------|
|
|
| **CLI Quickstart** | Get started with Swarms CLI in 3 steps—install, configure, and run | [View Guide](../swarms/cli/cli_quickstart.md) |
|
|
| **Creating Agents from CLI** | Create, configure, and run AI agents directly from your terminal | [View Guide](../swarms/cli/cli_agent_guide.md) |
|
|
| **YAML Configuration** | Run multiple agents from YAML configuration files | [View Guide](../swarms/cli/cli_yaml_guide.md) |
|
|
| **LLM Council CLI** | Run collaborative multi-agent decision-making from command line | [View Guide](../swarms/cli/cli_llm_council_guide.md) |
|
|
| **Heavy Swarm CLI** | Execute comprehensive task analysis swarms from terminal | [View Guide](../swarms/cli/cli_heavy_swarm_guide.md) |
|
|
| **CLI Multi-Agent Commands** | Complete guide to multi-agent CLI commands | [View Guide](./cli_multi_agent_quickstart.md) |
|
|
| **CLI Examples** | Additional CLI usage examples and patterns | [View Guide](../swarms/cli/cli_examples.md) |
|
|
|
|
---
|
|
|
|
## Use Cases
|
|
|
|
| Use Case | Recommended Guide |
|
|
|----------|-------------------|
|
|
| First time using CLI | [CLI Quickstart](../swarms/cli/cli_quickstart.md) |
|
|
| Creating custom agents | [Creating Agents from CLI](../swarms/cli/cli_agent_guide.md) |
|
|
| Team/production deployments | [YAML Configuration](../swarms/cli/cli_yaml_guide.md) |
|
|
| Collaborative decision-making | [LLM Council CLI](../swarms/cli/cli_llm_council_guide.md) |
|
|
| Complex research tasks | [Heavy Swarm CLI](../swarms/cli/cli_heavy_swarm_guide.md) |
|
|
|
|
---
|
|
|
|
## Related Resources
|
|
|
|
- [CLI Reference Documentation](../swarms/cli/cli_reference.md) - Complete command reference
|
|
- [Agent Documentation](../swarms/structs/agent.md) - Agent class reference
|
|
- [Environment Configuration](../swarms/install/env.md) - Environment setup guide
|