Getting Started
Choose Your Path
Which Should You Use?
Option | Best For | Why Choose It |
---|---|---|
CLI Recommended | Beginners, quick prototyping, CI/CD pipelines | Guided setup, no boilerplate, works with Studio and SDK |
SDK | Developers with existing Node.js projects, advanced customization | Fine-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.
- Install the CLI globally:
npm install -g @smythos/cli
- Create a new project interactively:
sre create
Step-by-Step Guidance
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
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
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