This guide will walk you through the process of setting up your development environment for Agentic Team OS.

Having a development environment is a great way to test your ideas without having to worry about breaking things.

The templates come with example agents you can use as a baseline for your own agents.

If you want to try the hosted version of Agentic Team OS, you can sign up for ATOS Cloud.

​
What prerequisites do you need?

  • Code Editor (Cursor AI, Windsurf, VSCode, etc)
  • MacOS or Linux Based OS
  • Node.js 20+
  • Package Manager (Yarn, NPM, PNPM, etc)
  • Dedicated Development AWS Account with AWS SSO
  • Github Account
  • Stripe Account
  • Clerk Account
  • Unkey Account
  • Cloudflare Account

Head over to account setups for help with prerequisites.

Time to Complete: 30 mins - 2 hrs

Using Agentic Team OS requires an intermediate level of experience with programming and cloud development. If you need help getting started or have questions, join the Community where you can get more access to more support and resources to get you up to speed.

​
1. Create a new project directory

mkdir my-agentic-project
cd my-agentic-project

​
2. Set up your Repos

Create a new repository from the API Template: API Template

Create a new repository from the Dashboard Template: Dashboard Template

# Clone Dashboard Template
cd my-agentic-project
gh repo clone <your-dashboard-repo-name>

# Clone API Template
cd my-agentic-project
gh repo clone <your-api-repo-name>

Each repo will have a .env.template file that you can use to set your environment variables. Change the .env.template file to .env.dev and update the variables:

Also update the sst.config.ts files with the an app name.

# sst.config.ts
export default $config({
  app(input) {
    return {
      name: "<YOUR-APP-NAME>",
      removal: input?.stage === "prod" ? "retain" : "remove",
      
      home: "aws",
      providers: { aws: {
        region: "us-east-1",
      }, "aws-native": {
        region: "us-east-1",
      }, 
      cloudflare: {
        version: "5.42.0",
        apiToken: process.env.CLOUDFLARE_API_TOKEN,
      }
    },
    };
  },
  ... rest of the config
});

​
Dashboard

# sst Secrets
baseDomain=<your-base-domain>
clerkSecretKey=<your-clerk-secret-key>
clerkSignInUrl=/sign-in
clerkSignUpUrl=/sign-up
clerkPublishableKey=<your-clerk-publishable-key>
subscriptionManagementUrl=<your-subscription-management-url>
stripePublishableKey=<your-stripe-publishable-key>

# nextjs variables
NEXT_API_URL=<your-next-api-url>
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=<your-clerk-after-sign-in-url>
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=<your-clerk-after-sign-up-url>

​
API

# sst Secrets
StripeSecretKey=<your-stripe-secret-key>
StripeWebhookSecret=<your-stripe-webhook-secret>
PriceID=<your-price-id>
ClerkClientPublishableKey=<your-clerk-client-publishable-key>
ClerkClientSecretKey=<your-clerk-client-secret-key>
ClerkWebhookSecret=<your-clerk-webhook-secret>
UnkeyRootKey=<your-unkey-root-key>
UnkeyApiId=<your-unkey-api-id>
OpenAIApiKey=<your-openai-api-key>


## Domain
CLOUDFLARE_API_TOKEN=<your-cloudflare-api-token>
BASE_DOMAIN=<your-base-domain>

If you find these templates helpful, please consider giving them a star on GitHub!

For each repo, run the following commands:

yarn install
yarn install sst # Upgrades sst to the latest version

​
3. Start your development environment

1

Set AWS Profile

Export your AWS profile for the account you want to deploy to:

export AWS_PROFILE=<your-aws-profile>
2

Install API Dependencies

Navigate to the API directory and install dependencies:

cd api
yarn install
yarn install sst
3

Load Environment Secrets

Load your development environment secrets:

yarn sst secrets load .env.dev --stage dev
4

Start Development API

Start the API in development mode:

yarn sst dev --stage dev

This will start your API and begin listening for Stripe and Clerk events. The first deployment may take a few minutes as it creates DNS records.

5

Start Dashboard

In a separate terminal, start the dashboard:

cd dashboard
yarn dev

The dashboard will run locally but can communicate with your hosted API.

6

Access Your Applications

Your applications will be available at:

Sign up through the dashboard to start using the example agents.

​
Next Steps

Was this page helpful?