Overview
The Upstreet Agents SDK is the first React-based SDK for building and deploying headless AI agents, locally and in the cloud.
Upstreet SDK (USDK)
AI Agents SDK in TypeScript and React.
Table of Contents
- Overview
- Supported Environments
- Quick Install
- What is Upstreet SDK?
- How does Upstreet SDK help?
- Key Features
- Commands
- Documentation
- License
Overview
Upstreet SDK (USDK) is a simple yet powerful command-line interface to build, test and deploy Upstreet AI Agents at scale.
USDK is crafted to give you the freedom to build Agents independently, yet also make your interaction with Upstreet's platform easier, allowing effortless creation, management, and communication with autonomous Upstreet AI Agents.
Supported Environments
USDK integrates smoothly with various development environments:
- Node.js (version 22.9.0 and above)
- Windows, macOS, and Linux compatible
Quick Install
Embark on your Upstreet journey in seconds:
npm install -g usdkWhat is Upstreet SDK and How Does It Help?
Upstreet SDK is your all-access pass to the world of Upstreet Agents, designed to enhance your experience through a powerful Command Line Interface (CLI).
Here's how USDK empowers you:
-
Craft and Manage Agents: Create and customize unique Upstreet Agents with user-friendly commands.
-
Natural Conversations: Engage in fluid, natural language interactions with Agents through our multi-agent chat interface.
-
Account Management: Authenticate and log account details.
-
Streamlined Workflow: From Agent creation to deployment, USDK simplifies every step of your journey in the Upstreet ecosystem.
Dive into the boundless potential of Upstreet Agents, whether you're an AI enthusiast, a developer, or a curious explorer.
Key Features
- Intuitive CLI: User-friendly commands for seamless interaction
- Agent Management: Create, list, edit and remove your AI Agents effortlessly
- Multi-Agent Chat: Engage in rich, dynamic conversations with multiple Upstreet Agents
Commands
Explore the power of USDK with these core commands:
usdk version
Display the current version of the SDK.
usdk versionusdk login
Log in to the SDK.
usdk loginusdk logout
Log out of the SDK.
usdk logoutusdk status
Check the current login status of the SDK and display account details.
usdk statususdk create
Create a new agent, from either a prompt or template.
usdk create [directory] [options]Options:
-p, --prompt <string>: Creation prompt-feat, --feature <feature...>: Specify features for the agent-f, --force: Overwrite existing files-F, --force-no-confirm: Overwrite existing files without confirming-j, --json <string>: Agent JSON string to initialize with-y, --yes: Non-interactive mode-s, --source <string>: Main source file for the agent
usdk edit
Edit an existing agent.
usdk edit [directory] [options]Options:
-p, --prompt <string>: Edit prompt-af, --add-feature <feature...>: Add a feature-rf, --remove-feature <feature...>: Remove a feature
usdk pull
Download source of deployed agent.
usdk pull <agent-id> [directory] [options]Options:
-f, --force: Overwrite existing files-F, --force-no-confirm: Overwrite existing files without confirming
usdk chat
Chat with agents in a multiplayer room.
usdk chat [agent-ids...] [options]Options:
-b, --browser: Open the chat room in a browser window-r, --room <room>: The room name to join-g, --debug: Enable debug logging
usdk deploy
Deploy an agent to the network.
usdk deploy [agent-ids...]usdk rm
Remove a deployed agent from the network.
usdk rm [agent-ids...]For a full command reference, use usdk --help or usdk <command> --help.
Documentation
Dive deeper into Upstreet SDK with our comprehensive guides:
License
Upstreet SDK is released under the ISC License.
We're thrilled to have you join the Upstreet community! As you explore and create with USDK, remember that our support team and community forums are always here to help.
👉 Join our Discord community to log issues and find inspiration: https://upstreet.ai/usdk-discord
👉 Talk to us directly for deeper issues, and commercial usage: hello@upstreet.ai
Happy creating in Upstreet! 🌆🚀