Skip to main content

Getting Started

Choose Your Path

You can start building with the SmythOS Runtime Environment (SRE) in two ways:

  • CLI: fastest and most guided setup
  • SDK: flexible, direct integration into existing code

Which Should You Use?

OptionBest ForWhy Choose It
CLI RecommendedBeginners, quick prototyping, CI/CD pipelinesGuided setup, no boilerplate, works with Studio and SDK
SDKDevelopers with existing Node.js projects, advanced customizationFine-grained control, direct integration into your codebase

Method 1: CLI Installation Recommended

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

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

The CLI prompts you for language, project name, and configuration.
It sets up everything needed so you can focus on building your agent.

Method 2: SDK Installation

If you’re adding SRE to an existing Node.js project, install the SDK directly:

npm install @smythos/sdk

or

pnpm install @smythos/sdk
When to choose the SDK

Use the SDK install method if:

  • You’re integrating into an existing codebase
  • You need fine-grained control over configuration
    For new projects, the CLI is recommended.

Verifying Your Setup

After installing either method, you can verify the environment:

sre --version

For SDK installs, confirm your dependency is listed in package.json.

Common mistake

If sre is not recognized, make sure your npm global bin directory is in your PATH.

Next Steps

Once you’ve installed and verified your setup, you’re ready to build and run your first agent.

  • Follow the Quickstart to create and deploy a working agent
  • Explore the CLI Guide for automation and scripting
  • Dive into the SDK Guide for programmatic workflows
  • Learn more in the Runtime Overview to understand how SRE works under the hood