-
Notifications
You must be signed in to change notification settings - Fork 16
feat(CLI): initial documentation for CLI #304
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
feat(CLI): initial documentation for CLI #304
Conversation
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
||
The CLI requires authentication with a CodeSandbox API token. You can obtain one from https://codesandbox.io/t/api. | ||
|
||
Set your API token using the `CSB_API_KEY` environment variable: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should also mention the TOGETHER_API_KEY
, it seems to be supported
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please don't mention that in the docs -- that is still a WIP and is not really supported fully yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we update the error message then? Right now it says "CSB_API_KEY or TOGETHER_API_KEY is not set"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah maybe a good idea.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed the reference in the SDK here: codesandbox/codesandbox-sdk#132
Added docs for the CLI reference. The page can be previewed on: https://msh43r-3000.csb.app/sdk/cli. Screenshot of the page shown below.