CLI Tools | SignalWire

The SignalWire Server SDK ships with command-line tools for local development, testing, knowledge base management, project scaffolding, and deployment. All CLI tools are installed automatically with the SDK package and available on your PATH after installation.

pip install signalwire-sdk

Available Tools

Command	Purpose
`swaig-test`	Test SWAIG functions and generate SWML output locally
`sw-search`	Build, search, and validate vector search indexes
`sw-agent-init`	Scaffold new agent projects with templates
`sw-agent-dokku`	Deploy agents to Dokku hosting
`mcp-gateway`	Bridge MCP servers to SWAIG functions

Common Patterns

Local Development Workflow

# 1. Create a new project
sw-agent-init my-agent
# 2. Inspect the generated SWML
swaig-test agents/main_agent.py --dump-swml
# 3. List available tools
swaig-test agents/main_agent.py --list-tools
# 4. Test a specific function
swaig-test agents/main_agent.py --exec get_info --topic "SignalWire"

Building a Knowledge Base

# Build a search index from documentation
sw-search ./docs --output knowledge.swsearch
# Verify the index
sw-search validate knowledge.swsearch
# Test search queries
sw-search search knowledge.swsearch "how to create an agent"

Deployment

# Deploy to Dokku
sw-agent-dokku init my-agent --host dokku.example.com
sw-agent-dokku deploy

Installation Extras

Some CLI tools require optional dependencies:

Extra	Install Command	Required For
`search`	`pip install "signalwire-sdk[search]"`	`sw-search` build and query
`search-full`	`pip install "signalwire-sdk[search-full]"`	PDF and DOCX processing
`search-nlp`	`pip install "signalwire-sdk[search-nlp]"`	Advanced NLP features (spaCy)
`search-queryonly`	`pip install "signalwire-sdk[search-queryonly]"`	Query-only mode (smaller install)
`pgvector`	`pip install "signalwire-sdk[pgvector]"`	PostgreSQL vector storage

swaig-test

Test SWAIG functions, generate SWML, and simulate serverless environments.

sw-search

Build, search, and validate vector search indexes for agent knowledge bases.

sw-agent-init

Scaffold new agent projects with configurable templates and platform targets.

sw-agent-dokku

Deploy and manage agents on Dokku with CI/CD support.

mcp-gateway

Bridge MCP protocol servers to SignalWire SWAIG functions.