Inworld CLI Overview
The Inworld CLI enables local development, testing, and deployment of AI graphs. Get started with installation, authentication, and your first graph project.Key Capabilities
- Local Development: Create and test graphs in your development environment
- Project Templates: Bootstrap projects with production-ready templates (including LLM+TTS samples)
- Authentication: Secure access to Inworld services
- Local Servers: HTTP and gRPC servers for integration testing
- Graph Management: Visualization, deployment, and variant management
Prerequisites
Before you get started, please make sure you have the following installed:- MacOS (arm64)
- Linux x64
- Windows x64
- macOS 14 and later
- Node.js v20 or higher
- Yarn or npm
- graphviz - Optional. Install this if you want to visualize your graph.
Setup
1
Install CLI
Create a new test folder and install the Inworld CLI globally.Verify the installation by checking available commands:
- Command
- Expected Output
2
Authenticate with Inworld Platform
Log into your Inworld account to access platform services.Verify your authentication status:
- Command
- Expected Output
- Command
- Expected Output
3
Create Your First Project
The
inworld init command downloads the llm-to-tts-node template—a production-ready LLM to TTS pipeline with GPT-4o-mini (by default) and TTS.Currently, only the
llm-to-tts-node template is available via CLI. To view all available templates, visit inworld.ai/templates.- Command
- Advanced Options
4
Install Dependencies
Navigate to your project directory and install the required Node.js dependencies.Your CLI setup is now complete! You can start testing your graph locally.
Local Development & Testing
- Command
- Expected Output
Local Servers
Available transports:http(default) - REST API with optional Swagger UIgrpc- gRPC server for high-performance applications
- Command
- Expected Output
Test HTTP Requests
- Command
- Expected Output
Next Steps
Once you have your CLI set up and tested locally, you can:- Deploy to Cloud - Deploy your graphs to Inworld Cloud
- Experiments - Build, register, target, and monitor variants end to end
- Experiments UI - Manage Portal targeting rules and rollouts
Need Help?
- Setup & development issues? See CLI Troubleshooting Guide
- Advanced workflows & production issues? See Experiments for the full CLI + Portal loop
- General CLI help: Run
inworld helporinworld [command] --help