Command Reference - Upstreet Documentation

The following table contains all the usdk command-line interface commands, their descriptions, and any additional subcommands or switches they have.

These commands are also visible in the Terminal if you run usdk --help.

Command	Description	Subcommands & Switches
`version`	Print the version of the SDK
`login`	Log in to the SDK
`logout`	Log out of the SDK
`status`	Print the current login status of the SDK
`create`	Create a new agent, from either a prompt or template	`-p, --prompt <string>`: Creation prompt `-i, --input <file>`: Initialize from file (character card) `-pfp, --profile-picture <file>`: Set the profile picture `-hs, --home-space <file>`: Set the home space `-j, --json <string>`: Agent JSON string to initialize with (e.g '{"name": "Ally", "description": "She is cool"}') `-y, --yes`: Non-interactive mode `-f, --force`: Overwrite existing files `-n, --no-install`: Do not install dependencies `-F, --force-no-confirm`: Overwrite existing files without confirming Useful for headless environments. [31mWARNING: Data loss can occur. Use at your own risk.[39m `-s, --source <string>`: Main source file for the agent. [31mREQUIRED: Agent Json string must be provided using -j option[39m `-feat, --feature <feature...>`: Provide either a feature name or a JSON string with feature details. Default values are used if specifications are not provided. Supported features: [32m"tts", example using json {"voiceEndpoint":"elevenlabs:kadio:YkP683vAWY3rTjcuq2hX"}. "rateLimit", example using json {"maxUserMessages":5,"maxUserMessagesTime":60000,"message":"Whoa there! Take a moment."}. "discord", example using json {"token":"YOUR_DISCORD_BOT_TOKEN","channels":["general","voice"]}. "twitterBot", example using json {"token":"YOUR_TWITTER_BOT_TOKEN"}. "telnyx", example using json {"apiKey":"YOUR_TELNYX_API_KEY","phoneNumber":"+14151234567","message":true,"voice":true}. "storeItems", example using json {"type":"payment","props":{"name":"Art","description":"An art piece","amount":499,"currency":"usd"}}[39m
`edit`	Edit an existing agent	`-p, --prompt <string>`: Edit prompt `-i, --input <file>`: Update from file (character card) `-pfp, --profile-picture <file>`: Set the profile picture `-hs, --home-space <file>`: Set the home space `-af, --add-feature <feature...>`: Add a feature `-rf, --remove-feature <feature...>`: Remove a feature
`pull`	Download source of deployed agent	`-f, --force`: Overwrite existing files `-F, --force-no-confirm`: Overwrite existing files without confirming Useful for headless environments. [31mWARNING: Data loss can occur. Use at your own risk.[39m
`run`	Run an agent	`-run, --runtime <runtime>`: The runtime to use; one of ["node","wrangler","electron"]
`chat`	Chat with agents in a multiplayer room	`-b, --browser`: Open the chat room in a browser window `-r, --room <room>`: The room name to join `-run, --runtime <runtime>`: The runtime to use; one of ["node","wrangler","electron"] `-g, --debug`: Enable debug logging
`deploy`	Deploy an agent to the network
`agents`	List the currently deployed agents
`unpublish`	Unpublish a deployed agent from the network
`authenticate`	Configure agent's authentication token	`-f, --force`: Force update even if there are conflicts
`update`	Update an agent to the latest sdk version	`-f, --force`: Force update even if there are conflicts
`voice`	Manage agent voices