Skip to main content

CLI for Simultaneous SDK

Project description

Simultaneous CLI

Command line interface for Simultaneous SDK.

Installation

# Install CLI separately (optional)
pip install -e ./cli

# Or install with CLI extras
pip install -e ".[cli]"

Configuration

The CLI uses the hosted API at https://simultaneous-api.fly.dev by default. You can override this with:

export SIMULTANEOUS_API_URL=https://your-api-url.com
export SIMULTANEOUS_FRONTEND_URL=https://your-frontend-url.com

Local Development

To use a locally running API:

# Linux/Mac
export SIMULTANEOUS_API_URL="http://localhost:8000"

# Windows (PowerShell)
$env:SIMULTANEOUS_API_URL="http://localhost:8000"

# Windows (CMD)
set SIMULTANEOUS_API_URL=http://localhost:8000

Then start the API locally:

cd api
python -m uvicorn main:app --host 0.0.0.0 --port 8000 --reload

See LOCAL_DEV_SETUP.md in the project root for detailed local development setup.

Usage

Authentication

# Sign up
sim auth signup

# Sign in (prompts for credentials)
sim auth signin

# Sign in via web browser (opens browser for OAuth redirect flow)
sim auth signin --web

# Or simply run without credentials to use web flow
sim auth signin

# Check auth status
sim auth status

# Show current user
sim auth whoami

# Sign out
sim auth signout

Organization Management

# Create organization
sim orgs create <org-name>

# List organizations
sim orgs list

Project Management

# Create project
sim projects create <project-name> [--slug <slug>]

# List projects
sim projects list [--archived]

# Get project details
sim projects get <project-id>

# Delete project
sim projects delete <project-id>

Agent Management

# Create agent
sim agents create <project-id> \
  --name <agent-name> \
  --script <script-content> \
  --script-file <path-to-script> \
  --provider-project-id <browserbase-project-id> \
  [--description <description>] \
  [--env-vars <json-encoded-env-vars>] \
  [--context-id <context-id>] \
  [--extension-id <extension-id>] \
  [--region <region>] \
  [--timeout-sec <seconds>]

# List agents in a project
sim agents list <project-id> [--active-only]

# Get agent details
sim agents get <project-id> <agent-id>

# Delete agent
sim agents delete <project-id> <agent-id>

Running Agents

# Run an agent
sim run <agent-name> \
  --project-id <project-id> \
  --agent-id <agent-id> \
  --params '{"key": "value"}'

Marketplace

# Publish agent to marketplace
sim marketplace publish <agent-id> [--project-id <project-id>] [--public/--private]

# List marketplace agents
sim marketplace list

# Deploy agent from marketplace
sim marketplace deploy <marketplace-agent-id> <project-id>

Deployment

# Deploy agent to cloud (Modal - placeholder for future implementation)
sim deploy agent <project-id> <agent-id>

Setup

  1. Create a .env file in the project root with (optional, for Supabase fallback):
SUPABASE_URL=https://your-project-id.supabase.co
SUPABASE_KEY=your-anon-public-key

You can find these in your Supabase Dashboard: Settings → API

Note: The CLI primarily uses the hosted API at https://simultaneous-api.fly.dev. The Supabase credentials are only used as a fallback for authentication.

Development

# Run CLI in development mode
python -m cli.main

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simultaneous_cli-0.1.1.tar.gz (24.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simultaneous_cli-0.1.1-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file simultaneous_cli-0.1.1.tar.gz.

File metadata

  • Download URL: simultaneous_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for simultaneous_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a5de88761140b9110963c91ffd0e27a4fc49013d867a48c702ee8d387bb36e71
MD5 b248105fecb4731e26c096770e6820cc
BLAKE2b-256 8040868ac8217c1b898b6144e958aa393ea78365b136d7a0b89c22349e185d89

See more details on using hashes here.

File details

Details for the file simultaneous_cli-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for simultaneous_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5b5c384f57d09d6eb94bc84d41483dbeccf65cd4a5db103c5cf94cb6e900749f
MD5 5cf0f093f042d167542f53143f6554b4
BLAKE2b-256 70c8f3f987e312ddcba6ba7e8acdfef7d07dddfbb9e396da05029552b948156a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page