For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
GuidesReference
GuidesReference
    • Core
      • Overview
    • Agents
      • Overview
      • AgentBase
      • AgentServer
      • BedrockAgent
      • CLI Tools
        • mcp-gateway
        • sw-agent-dokku
        • sw-agent-init
        • sw-search
        • swaig-test
      • Configuration
      • ContextBuilder
      • DataMap
      • FunctionResult
      • Helper Functions
      • LiveWire
      • MCP Gateway
      • PomBuilder
      • Prefabs
      • Search
      • SkillBase
      • Skills
      • SWAIGFunction
      • SWMLBuilder
      • SWMLService
      • WebService
    • RELAY
      • Overview
      • Actions
      • Call
      • Constants
      • Events
      • Message
      • RelayClient
      • RelayError
    • REST Client
      • Overview
      • Addresses
      • Calling
      • Chat
      • Compat
      • Datasphere
      • Fabric
      • Imported Numbers
      • Logs
      • Lookup
      • MFA
      • Number Groups
      • Phone Numbers
      • Project
      • PubSub
      • Queues
      • Recordings
      • Registry
      • RestClient
      • Short Codes
      • SignalWireRestError
      • SIP Profile
      • Verified Callers
      • Video
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Available Tools
  • Common Patterns
  • Local Development Workflow
  • Building a Knowledge Base
  • Deployment
  • Installation Extras
Agents

CLI Tools

|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

mcp-gateway

Next
Built with

The SignalWire Agents 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

CommandPurpose
swaig-testTest SWAIG functions and generate SWML output locally
sw-searchBuild, search, and validate vector search indexes
sw-agent-initScaffold new agent projects with templates
sw-agent-dokkuDeploy agents to Dokku hosting
mcp-gatewayBridge 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:

ExtraInstall CommandRequired For
searchpip install "signalwire-sdk[search]"sw-search build and query
search-fullpip install "signalwire-sdk[search-full]"PDF and DOCX processing
search-nlppip install "signalwire-sdk[search-nlp]"Advanced NLP features (spaCy)
search-queryonlypip install "signalwire-sdk[search-queryonly]"Query-only mode (smaller install)
pgvectorpip 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.