Skip to content

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tristandubbeld
Copy link
Contributor

@tristandubbeld tristandubbeld commented Jul 16, 2025

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.

image

Copy link

codesandbox bot commented Jul 16, 2025

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

vercel bot commented Jul 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
projects-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 16, 2025 0:41am


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:

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

Copy link

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.

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"

Copy link

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.

Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants