UpstreetAI / monorepo

Upstreet AI Monorepo
https://upstreet.ai
0 stars 0 forks source link

[Docs] document sdk commands #460

Closed avaer closed 3 days ago

avaer commented 6 days ago

We should better explain how to create + edit your agent using usdk.

Maybe we need videos?

AbdurrehmanSubhani commented 6 days ago

Current USDK help logs:

(base) abdurrehmansubhani@Abdurrehmans-MacBook-Pro monorepo % usdk help
Usage: usdk [options] [command]

Upstreet Agents SDK

Options:
  -V, --version                      output the version number
  -h, --help                         display help for command

Commands:
  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 [options] [directory]       Create a new agent, from either a prompt or template
  edit [options] [directory]         Edit an existing agent
  pull [options] <guid> [directory]  Download source of deployed agent
  chat [options] [guids...]          Chat with agents in a multiplayer room
  test [options] [directories...]    Run agent tests
  deploy [guids...]                  Deploy an agent to the network
  agents                             List the currently deployed agents
  unpublish [guids...]               Unpublish a deployed agent from the network
  help [command]                     display help for command
(base) abdurrehmansubhani@Abdurrehmans-MacBook-Pro monorepo % usdk chat --help
Usage: usdk chat [options] [guids...]

Chat with agents in a multiplayer room

Arguments:
  guids              Guids of the agents to join the room

Options:
  -b, --browser      Open the chat room in a browser window
  -r, --room <room>  The room name to join
  -g, --debug        Enable debug logging
  -h, --help         display help for command
(base) abdurrehmansubhani@Abdurrehmans-MacBook-Pro monorepo %      
SaadBazaz commented 6 days ago

It seems well-documented in usdk help, but we need to add this to the Docs website as well.