Skip to main content

Getting Started

Choose Your Path

You can start building with the SmythOS Runtime Environment (SRE) using either the CLI or the SDK. Choose the method that best fits your workflow and experience.

Method 1: Using the CLI Recommended​

The CLI is the simplest and most guided way to create and configure new agent projects.

  1. Install the CLI globally:
npm i -g @smythos/cli
  1. Create a new project interactively:
sre create
Step-by-Step Guidance

The CLI will walk you through setting up your project and configuration, making it easy to get started quickly.

Method 2: Direct SDK Installation​

If you want to add SmythOS to an existing Node.js project, you can install the SDK directly:

npm install @smythos/sdk

or

pnpm install @smythos/sdk
When to Use the SDK Install

The direct SDK method is best if you already have a codebase or want fine-grained control over integration.
For new projects, the CLI is recommended.

Once you’ve completed either method, you’re ready to build and run your first agent.

Continue to the Quickstart for a complete example.