{"id":49308607,"url":"https://github.com/togethercomputer/together-sandbox","last_synced_at":"2026-05-06T10:02:39.260Z","repository":{"id":350215793,"uuid":"1168438760","full_name":"togethercomputer/together-sandbox","owner":"togethercomputer","description":"SDKs and CLIs for working with Together Sandboxes","archived":false,"fork":false,"pushed_at":"2026-04-23T13:30:43.000Z","size":931,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-23T15:12:16.664Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/togethercomputer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-27T11:46:07.000Z","updated_at":"2026-04-23T13:30:25.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/togethercomputer/together-sandbox","commit_stats":null,"previous_names":["togethercomputer/together-sandbox"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/togethercomputer/together-sandbox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/togethercomputer%2Ftogether-sandbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/togethercomputer%2Ftogether-sandbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/togethercomputer%2Ftogether-sandbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/togethercomputer%2Ftogether-sandbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/togethercomputer","download_url":"https://codeload.github.com/togethercomputer/together-sandbox/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/togethercomputer%2Ftogether-sandbox/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32294591,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T09:34:17.070Z","status":"ssl_error","status_checked_at":"2026-04-26T09:34:00.993Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-26T11:02:19.443Z","updated_at":"2026-04-26T11:02:20.101Z","avatar_url":"https://github.com/togethercomputer.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Together Sandbox\n\nTools for working with Together AI sandboxes: a CLI, a TypeScript SDK, and a Python SDK.\n\n## Quick Start\n\nAll three components can be installed directly from GitHub without npm or PyPI publication:\n\n```bash\n# CLI\ncurl -fsSL https://raw.githubusercontent.com/togethercomputer/together-sandbox/main/install.sh | bash\n\n# TypeScript SDK\nnpm install https://github.com/togethercomputer/together-sandbox/releases/latest/download/together-sandbox-sdk.tgz\n\n# Python SDK\npip install \"together-sandbox @ git+https://github.com/togethercomputer/together-sandbox.git#subdirectory=together-sandbox-python\"\n```\n\nSet your Together AI API key:\n\n```bash\nexport TOGETHER_API_KEY=your_api_key\n```\n\n## CLI\n\n### `build`\n\nBuilds and deploys a sandbox from the current directory.\n\n```bash\ntogether-sandbox build \u003cdirectory\u003e\n```\n\n---\n\n## TypeScript SDK\n\n```typescript\nimport { TogetherSandbox } from \"@together-sandbox/sdk\";\n\nconst sdk = new TogetherSandbox({ apiKey: process.env.TOGETHER_API_KEY });\n\n// Start a sandbox — URL/token wiring is handled automatically\nconst sandbox = await sdk.sandboxes.start(\"your-sandbox-id\");\n\n// Read a file — returns the file content as a string\nconst content = await sandbox.files.read(\"/package.json\");\nconsole.log(content);\n\n// Run a command\nconst exec = await sandbox.execs.create({\n  command: \"bash\",\n  args: [\"-c\", \"echo hello\"],\n});\n\n// Shutdown when done\nawait sandbox.shutdown();\n```\n\nThe low-level generated clients are also available for advanced use. See the [TypeScript SDK README](together-sandbox-typescript/README.md) for details.\n\n---\n\n## Python SDK\n\n```python\nimport asyncio\nfrom together_sandbox import TogetherSandbox\n\nasync def main():\n    # api_key defaults to TOGETHER_API_KEY environment variable\n    sdk = TogetherSandbox(api_key=\"your-api-key\")\n\n    # Start a sandbox — URL/token wiring is handled automatically\n    async with await sdk.sandboxes.start(\"your-sandbox-id\") as sb:\n        content = await sb.files.read(\"/package.json\")\n        print(content)\n\nasyncio.run(main())\n```\n\nThe low-level generated clients are also available for advanced use. See the [Python SDK README](together-sandbox-python/README.md) for details.\n\n---\n\n### Troubleshooting\n\n| Issue                        | Solution                                                      |\n| ---------------------------- | ------------------------------------------------------------- |\n| **CLI not found**            | Ensure `/usr/local/bin` is in your PATH, or use `INSTALL_DIR` |\n| **TypeScript SDK 404**       | Verify the release exists and you have repository access      |\n| **Python SDK install fails** | Ensure you have git installed and repository access           |\n| **Authentication errors**    | Check your `TOGETHER_API_KEY` environment variable            |\n\n---\n\n## Development\n\n### Regenerating clients\n\nIf the OpenAPI specs change, regenerate all clients from the repo root:\n\n```bash\nbash generate.sh\n```\n\n## Release Process\n\nReleases are fully automated via **release-please** — no manual tagging or version bumping required.\n\n### How it works\n\n1. **Merge PRs to `main` using Conventional Commits** — the commit type determines what kind of release is created:\n   - `feat:` → minor version bump\n   - `fix:` → patch version bump\n   - `feat!:` / `BREAKING CHANGE:` → major version bump\n   - `chore:`, `docs:`, etc. → no release\n\n2. **release-please opens a \"Release PR\"** automatically, accumulating changes and\n   updating `CHANGELOG.md` plus all three version files in sync:\n   - `together-sandbox-typescript/package.json`\n   - `together-sandbox-cli/package.json`\n   - `together-sandbox-python/pyproject.toml`\n\n3. **Merge the Release PR** → release-please creates the GitHub Release and tag automatically.\n\n4. **The `build-and-upload` job triggers** and:\n   - Regenerates SDK clients (`bash generate.sh`)\n   - Builds and packs the TypeScript SDK → `together-sandbox-sdk.tgz`\n   - Compiles CLI binaries for all 5 platforms (darwin arm64/x64, linux x64/arm64, windows x64)\n   - Uploads all artifacts to the GitHub Release\n\nThe only human action required is keeping commits conventional and merging the Release PR when ready to ship.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftogethercomputer%2Ftogether-sandbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftogethercomputer%2Ftogether-sandbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftogethercomputer%2Ftogether-sandbox/lists"}