Conversation
There was a problem hiding this comment.
Pull request overview
Adds initial end-user documentation for the Together Sandbox toolchain (TypeScript SDK, Python SDK, and CLI) so developers can install, authenticate, and use the APIs/commands.
Changes:
- Add TypeScript SDK usage and API reference (
@together-sandbox/sdk) - Add Python SDK usage and API reference (
together-sandbox) - Add CLI installation/usage docs (
@together-sandbox/cli)
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/typescript-sdk.md | New TypeScript SDK guide with lifecycle + sandbox sub-namespace API docs |
| docs/python-sdk.md | New Python SDK guide with async usage patterns and API docs |
| docs/cli.md | New CLI guide describing build workflow, args/options, and env vars |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The main entry point for the SDK. | ||
|
|
||
| ```typescript | ||
| const sdk = new TogetherSandbox(config: TogetherSandboxConfig); |
There was a problem hiding this comment.
The constructor example uses new TogetherSandbox(config: TogetherSandboxConfig), which isn’t valid TypeScript syntax for a function call. Consider either showing new TogetherSandbox(config) or declaring const config: TogetherSandboxConfig = ... before passing it in, so the snippet can be copied/pasted.
| const sdk = new TogetherSandbox(config: TogetherSandboxConfig); | |
| const sdk = new TogetherSandbox({ apiKey: process.env.TOGETHER_API_KEY! }); |
|
|
||
| | Property | Type | Required | Description | | ||
| | --------- | -------- | -------- | ------------------------------------------------------------------------------- | | ||
| | `apiKey` | `string` | Yes | Together AI API key. Falls back to `TOGETHER_API_KEY` env var if not set. | |
There was a problem hiding this comment.
TogetherSandboxConfig.apiKey is marked as required, but the description says it falls back to TOGETHER_API_KEY “if not set”. In the actual TypeScript type (TogetherSandboxConfig), apiKey is not optional, so the fallback language is misleading unless the interface is changed. Please align the table with the public TypeScript API (either make apiKey optional in code, or remove the fallback claim here).
| | `apiKey` | `string` | Yes | Together AI API key. Falls back to `TOGETHER_API_KEY` env var if not set. | | |
| | `apiKey` | `string` | Yes | Together AI API key. | |
| | Property | Type | Required | Description | | ||
| | --------- | -------- | -------- | ------------------------------------------------------------------------------- | | ||
| | `apiKey` | `string` | Yes | Together AI API key. Falls back to `TOGETHER_API_KEY` env var if not set. | | ||
| | `baseUrl` | `string` | No | Override the management API base URL. Defaults to `https://api.codesandbox.io`. | | ||
|
|
There was a problem hiding this comment.
The markdown tables are written with a leading || on each row (e.g. || Property | Type | ... |), which renders as an extra empty first column in most Markdown renderers. Consider switching to a single leading | per row to produce the intended columns.
| | Parameter | Type | Description | | ||
| | ---------- | ------------- | ------------------------------------------------------------------ | | ||
| | `api_key` | `str \| None` | Together AI API key. Falls back to the `TOGETHER_API_KEY` env var. | | ||
| | `base_url` | `str` | Management API base URL. Defaults to `https://api.codesandbox.io`. | | ||
|
|
There was a problem hiding this comment.
The parameter table rows start with || (double pipe), which typically renders as an extra empty column in Markdown. Consider using a single leading | for the table rows so the columns align correctly in rendered docs.
| #### Arguments | ||
|
|
||
| | Argument | Description | | ||
| | ------------- | ------------------------------------------------------ | | ||
| | `<directory>` | Path to the project directory to build from. Required. | | ||
|
|
||
| #### Options | ||
|
|
||
| | Option | Type | Default | Description | | ||
| | ---------------- | --------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `--name` | `string` | — | Display name for the resulting sandbox template. | | ||
| | `--alias` | `string` | — | Alias that points to the created template. Format: `alias` or `namespace@alias`. Namespace defaults to the directory name. Characters: `a-z A-Z 0-9 - _`, max 64 chars each. | | ||
| | `--from-sandbox` | `string` | — | ID of an existing sandbox to use as the base template instead of the default. | | ||
| | `--vm-tier` | `string` | `Micro` | VM size for the template sandbox. One of: `Pico`, `Nano`, `Micro`, `Small`, `Medium`, `Large`, `XLarge`. | | ||
| | `--ci` | `boolean` | `false` | CI mode — exits the process with a non-zero code on any error. | | ||
| | `--log-path` | `string` | — | Relative path to write log output to a file. | |
There was a problem hiding this comment.
The Arguments/Options tables use || at the start of each row, which usually creates an unintended empty first column when rendered. Consider updating these tables to use a single leading | so they render with the expected columns.
No description provided.