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
- npm
- graphviz - Optional. Install this if you want to visualize your graph.
Get Started
1
Install Inworld CLI
Install the Inworld CLI globally.
2
Log in to your acount
Log in to your Inworld account to use Inworld Runtime. If you don’t have an account, you can create one when prompted to login.Once logged in, your credentials are stored and you won’t need to log in again.
3
Create your first project
The After the command completes, you’ll have a project directory with all dependencies installed.
inworld init command downloads the llm-to-tts-node template—a production-ready LLM to TTS pipeline.Currently, only the
llm-to-tts-node template is available via CLI. To view all available templates, visit inworld.ai/templates.4
Run your graph
Navigate to your project directory and run your pipeline with the appropriate inputs.
Run a local server
Now that you’ve successfully run your first graph, you can run a local server to test it in your application.1
Start the local server
Start your local server.You can see additional server configuration here (including support for gRPC and Swagger UI).
2
Test the API
Test the API with a simple curl command. Note that for the LLM to TTS pipeline, the API will return raw audio data that needs to be parsed in order to be played.Here is an example of the output
Make your first change
Now let’s make our first modification to the LLM to TTS pipeline. Let’s change the model and prompt.1
Modify graph.ts
Open up the graph.ts file in your project directory, which contains the graph configuration. Modify the
provider and modelName under RemoteLLMChatNode to any supported LLM.graph.ts
2
Test the API
Test your updated graph.
Next Steps
Now that you’ve learned the basics, explore more advanced features:Deploy to Cloud
Deploy your graphs to a hosted endpoint
Explore templates
Explore other templates to jumpstart your development
Need Help?
- General CLI help: Run
inworld helporinworld [command] --help - Setup & development issues? See CLI Troubleshooting Guide