Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
ec93be5
Add Scope.workspace for Blaxel client configuration.
cursoragent Nov 9, 2026
7cc2292
Add @sandbox-kit/blaxel TypeScript provider.
cursoragent Nov 9, 2026
ed217f3
Add Blaxel Go provider with create, FS, run, and delete.
cursoragent Nov 9, 2026
08950b1
Add Blaxel examples, docs, and site coverage.
cursoragent Nov 9, 2026
56349c6
Align Blaxel wiring with sibling providers and Blaxel floors.
cursoragent Nov 9, 2026
c3ef6ba
Merge pull request #45 from sandbox-kit/cursor/blaxel-wiring-fixes-7ca2
Nabhag8848 Nov 9, 2026
531ddae
Fix Blaxel Ready conflation and drop unproven floors.
cursoragent Nov 9, 2026
1166342
Merge pull request #46 from sandbox-kit/cursor/blaxel-review-fixes-7ca2
Nabhag8848 Nov 10, 2026
abaecfb
Align Blaxel Go/TS create and state mapping.
Nabhag8848 Nov 10, 2026
c5b68b9
Harden Blaxel create validation and timeout handling.
Nabhag8848 Nov 10, 2026
72d84a3
Document Blaxel Kit-only create deadline on the website.
Nabhag8848 Nov 10, 2026
87a6711
Document Blaxel memory pass-through, volumes out of scope, and TS set…
Nabhag8848 Nov 10, 2026
1be77ed
Document Blaxel Go examples and public API comments.
Nabhag8848 Nov 10, 2026
c508ac6
Bring repo Markdown Blaxel coverage in line with Daytona and Modal.
Nabhag8848 Nov 10, 2026
d707e22
Fill website Blaxel ForProvider panes and provider page parity.
Nabhag8848 Nov 10, 2026
fa0d26d
Close the Modal ForProvider pane in process docs.
Nabhag8848 Nov 10, 2026
561610b
Sync Blaxel TypeScript example locks to @blaxel/core 0.3.36.
Nabhag8848 Nov 10, 2026
94e5009
Remove unused Blaxel provider-level env templates.
Nabhag8848 Nov 10, 2026
0bd2db5
Align Blaxel create/process mappings with Blaxel defaults and docs.
Nabhag8848 Nov 10, 2026
d4b7c45
Map Blaxel POLICY_VIOLATION to invalid argument.
cursoragent Nov 10, 2026
4ff2bca
Merge pull request #47 from sandbox-kit/cursor/blaxel-policy-violatio…
Nabhag8848 Nov 10, 2026
f221fec
Fix Blaxel long-wait process path, Http2Tls rejection, and TS stat.
Nabhag8848 Nov 10, 2026
e8c2f89
Refactor Blaxel Go/TS providers for leaner structure and readability.
Nabhag8848 Nov 10, 2026
a224d5f
Point Blaxel example links at main for post-merge docs.
Nabhag8848 Nov 10, 2026
4d04800
Rename Blaxel example env key to BL_SANDBOX_NAME.
Nabhag8848 Nov 10, 2026
f46190d
Tighten Blaxel user docs so create, wait, idle, and env keys need no …
Nabhag8848 Nov 10, 2026
34fb696
Reformat Blaxel doc tables and wrapped prose for consistency.
Nabhag8848 Nov 10, 2026
64d6d15
Align Blaxel Go/TS workspace, idle-terminate fields, and DELETED state.
Nabhag8848 Nov 10, 2026
2b8ae9c
Reformat Blaxel docs settings tables after workspace wording update.
Nabhag8848 Nov 10, 2026
e47cb90
Set terminal on Blaxel TypeScript Deleted refresh.
Nabhag8848 Nov 10, 2026
cec4d3c
Align Blaxel provider YAML inventory with handwritten SDKs.
Nabhag8848 Nov 10, 2026
2e5e3a8
Compact Blaxel create-field YAML mapping style.
Nabhag8848 Nov 10, 2026
f13dd89
Harden Blaxel create checks and process wait budgets.
Nabhag8848 Nov 10, 2026
5262ab0
Bring core SDK docs and comments in line with the Blaxel provider.
Nabhag8848 Nov 10, 2026
5a202dc
Polish Blaxel soft debt: create options, standby, 409, Stat docs.
cursoragent Nov 10, 2026
950cecb
Align Blaxel with the unified client for portable create/delete/errors.
Nabhag8848 Nov 11, 2026
5a9f2f5
Simplify Blaxel delete to a unified Deleted outcome.
Nabhag8848 Nov 11, 2026
6548fd7
Simplify Blaxel run and stat to lightweight Kit outcomes.
Nabhag8848 Nov 11, 2026
9bb6692
Rewrite Blaxel user docs for SDK callers and fix TS Stat size.
Nabhag8848 Nov 11, 2026
cb9260c
Merge pull request #48 from sandbox-kit/cursor/blaxel-soft-debt-7ca2
Nabhag8848 Nov 11, 2026
117c13f
Honor Blaxel delete wait in Kit and document for SDK callers.
Nabhag8848 Nov 11, 2026
71aeae6
Harden Blaxel handle projection and Http2Tls rejection.
Nabhag8848 Nov 11, 2026
34c558e
Forward Blaxel create timeouts and tighten caller-facing docs.
Nabhag8848 Nov 11, 2026
c81e7a0
Align Blaxel Go/TS error kinds, duration text, and create info.
Nabhag8848 Nov 11, 2026
df70f75
Map Blaxel LOCKDOWN_ERROR to Internal and sync wait/lifetime inventory.
Nabhag8848 Nov 11, 2026
3cbe6c5
Remove dead Blaxel helpers and tighten wire-state projection.
Nabhag8848 Nov 11, 2026
4fc52f8
Align Blaxel name and Stat parity across Go, TypeScript, and docs.
Nabhag8848 Nov 11, 2026
8fe9497
Align Blaxel TypeScript filesystem error kinds with Go.
Nabhag8848 Nov 11, 2026
5999b91
Tighten Blaxel copyToLocal path errors and share listing detection.
Nabhag8848 Nov 11, 2026
f007d7b
Map Blaxel TypeScript providerSource and tighten caller notes.
Nabhag8848 Nov 11, 2026
41b1767
Drop Blaxel Go providerMetadata and createdAt from SandboxInfo.
Nabhag8848 Nov 11, 2026
c169bd7
Register Blaxel in sandbox-kit test go and typescript.
Nabhag8848 Nov 11, 2026
f327db5
Set @sandbox-kit/blaxel to 0.1.0 and clarify workspace config docs.
Nabhag8848 Nov 11, 2026
0bee266
Align Blaxel example deps and README with the 0.1.0 cut.
Nabhag8848 Nov 11, 2026
8620a77
Document Blaxel create 504 drift and omit blank workspace.
Nabhag8848 Nov 11, 2026
c8bc34e
docs: separate TypeScript and Go content
Nabhag8848 Nov 11, 2026
581f88d
fix: isolate Blaxel TypeScript configuration
Nabhag8848 Nov 12, 2026
8d7377b
fix: validate sandbox response identity
Nabhag8848 Nov 12, 2026
4ad2449
fix: harden client boundaries and credential serialization
Nabhag8848 Nov 13, 2026
b920d0c
fix: capture queued operation inputs
Nabhag8848 Nov 13, 2026
388ada9
fix: preserve filesystem options and long deadlines
Nabhag8848 Nov 13, 2026
2f921d2
fix: handle cancellation and protect write buffers
Nabhag8848 Nov 13, 2026
af788a5
fix: correct Blaxel resource and error handling
Nabhag8848 Nov 13, 2026
637b0b3
fix: reject nil Blaxel port bindings
Nabhag8848 Nov 13, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
58 changes: 42 additions & 16 deletions .agents/skills/docs-current-state/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,43 @@
---
name: docs-current-state
description: >-
Update project READMEs and Markdown guides as current-state truth only.
Use when writing or revising README.md, docs/, examples/**/README.md, or any
project guide after API, layout, architecture, or dependency changes; when
removing stale docs; or when the user asks to refine documentation.
Update project READMEs and Markdown/MDX guides as current-state truth for
end users and SDK callers (not SDK builders). Use when writing or revising
README.md, docs/, examples/**/README.md, sdks/**/README.md,
website/content/docs/**, or any product guide after API, layout,
architecture, or dependency changes; when removing stale docs; or when the
user asks to refine documentation.
---

# Docs: current state only
# Docs: current state, SDK-user audience

Write documentation that matches the repository **as it exists now**. Pair with
`crafting-effective-readmes` for README structure, `writing-clearly-and-concisely`
for prose, and `golang-documentation` for Go/doc-comment work. Use
`baoyu-format-markdown` only when the user asks to format or beautify markdown
layout without rewriting meaning.
Write documentation that matches the repository **as it exists now**, for
**people who call the SDK**. Pair with `crafting-effective-readmes` for README
structure, `writing-clearly-and-concisely` for prose, and
`golang-documentation` for Go/doc-comment work. Use `baoyu-format-markdown`
only when the user asks to format or beautify markdown layout without
rewriting meaning.

This skill aligns with `.cursor/rules/docs-current-state.mdc` and `AGENTS.md`.
This skill aligns with `.cursor/rules/docs-current-state.mdc`,
`.cursor/rules/docs-sdk-user-audience.mdc`, and `AGENTS.md`.

## Audience

Primary readers are application developers integrating `@sandbox-kit/*` or the
Go sandbox modules. Write like a technical documentation engineer for that
audience.

| For SDK users | Not for SDK builders |
| ----------------------------------- | --------------------------------------------------------- |
| What to call, pass, and expect back | Mapping layers, wire shapes, adapter internals |
| Provider-specific usage differences | Inventory YAML, proto regen, contributor workflows |
| Outcomes on the handle (`state`, …) | “Unified metadata”, ignored-option plumbing |
| Unsupported → say so + alternative | Negated field catalogs unless they prevent a real mistake |

Omit options the provider does not use from examples. If you must mention an
unused option, say the provider does not use it—do not say it is “accepted and
ignored.” Prefer listing fields the caller receives over listing fields that
stay empty.

## Rules

Expand All @@ -26,27 +48,31 @@ This skill aligns with `.cursor/rules/docs-current-state.mdc` and `AGENTS.md`.
3. **Replace stale content.** Delete outdated sections, examples, commands, and
claims. Do not keep deprecated paths "for context."
4. **Update with the code change.** When APIs, layout, architecture, examples,
or dependencies change, edit the relevant Markdown in the same task.
or dependencies change, edit the relevant Markdown/MDX in the same task.
5. **Stay silent in chat.** Do not announce "I also updated the README" unless
the user asked about docs. PR/commit summaries may mention docs when that is
part of the deliverable.
6. **Verify.** Check links and commands against the repo. Match examples to the
implemented API. Prefer one catalog of truth (`examples/README.md`) over
duplicated incomplete tables.
7. **Provider- and language-specific.** When behavior differs, say so under the
right provider/language section—do not paper over with generic wording.

## Scope

| Include | Exclude |
| --------------------------------------------- | --------------------------------------------- |
| Root/`docs/`/`examples/**` READMEs and guides | CHANGELOG, commit/PR history |
| SDK and tooling READMEs that describe usage | Skill packages under `.agents/skills/` |
| SDK package READMEs that describe usage | Skill packages under `.agents/skills/` |
| `website/content/docs/**` product + SDK pages | Contributor-only architecture unless asked |
| Out-of-scope notes stated as present facts | Roadmap or "planned / future work" narratives |

## Workflow

1. Identify which Markdown files describe the changed behavior.
2. Read those files and the matching code/examples.
3. Rewrite so each file is a clean current description; remove contradictions.
1. Identify which Markdown/MDX files describe the changed behavior.
2. Read those files and the matching public API / examples.
3. Rewrite so each file is a clean current description for an SDK caller;
remove contradictions and builder-only detail.
4. For README structure or audience fit, follow `crafting-effective-readmes`.
5. For sentence-level clarity, follow `writing-clearly-and-concisely`.
6. Do not prompt about incidental README edits after feature work unless
Expand Down
10 changes: 7 additions & 3 deletions .cursor/rules/docs-current-state.mdc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Keep docs and READMEs as current-state truth; update silently; remove outdated content
description: Keep docs and READMEs as current-state truth for SDK users; update silently; remove outdated content
alwaysApply: true
---

Expand All @@ -8,6 +8,9 @@ alwaysApply: true
When APIs, layout, architecture, examples, or dependencies change, update the
relevant README and project Markdown as part of the same work.

Audience for product and SDK docs is **end users and SDK callers**, not SDK
builders. Follow `.cursor/rules/docs-sdk-user-audience.mdc` for voice.

## Write what is true now

- Describe the project as it exists **today**. Present tense.
Expand All @@ -30,6 +33,7 @@ relevant README and project Markdown as part of the same work.

## Scope

- Applies to `README.md`, `docs/`, `examples/**/README.md`, and other project
Markdown that describes current behavior.
- Applies to `README.md`, `docs/`, `examples/**/README.md`,
`website/content/docs/**`, SDK package READMEs, and other project Markdown
that describes current behavior.
- Does not replace CHANGELOG or commit/PR history; keep those elsewhere.
51 changes: 51 additions & 0 deletions .cursor/rules/docs-sdk-user-audience.mdc
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
description: Write product and SDK docs for end users and SDK callers, not SDK builders
alwaysApply: true
---

# Docs audience: SDK users, not builders

Write README, guides, website docs, and SDK reference as a technical
documentation engineer for **people who call the SDK** (application
developers). Not for people who implement providers or maintain this repo.

## Voice

- Lead with what to call, what to pass, and what you get back.
- Prefer short how-to prose and working snippets over internal design notes.
- Keep provider- and language-specific behavior explicit when it differs.
- Present tense. Current behavior only (see `docs-current-state`).

## Do

- Name the public method and show a realistic call.
- Describe outcomes the caller can use (`state`, `terminal`, `exitCode`, …).
- Say what the caller must supply (credentials, name, image, region).
- Note unsupported operations as “not available” / “not supported” for that
provider, with the alternative when there is one.

## Do not

- Explain Kit internals, wire formats, mapping layers, or “unified” plumbing.
- Document ignored options as acceptance theater (“`wait` is accepted and
ignored”). Omit unused options from examples; if needed, say the provider
does not wait / does not use that option.
- Surface native `providerState` strings unless the caller must read them.
- Negate field catalogs (“does not fill `mode`”) unless that prevents a
real mistake; prefer listing what the caller actually receives.
- Write for SDK maintainers (inventory YAML, proto regeneration, adapter
shapes) in user-facing docs. Keep that in `AGENTS.md` / contributor docs.

## Examples

```md
<!-- Bad: builder voice -->

Deletes and returns unified Deleted metadata (`providerState: "TERMINATED"`).
`wait` is accepted and ignored.

<!-- Good: SDK-user voice -->

Deletes the sandbox. On success, `info.state` is `deleted` and `terminal` is
true. Pass `wait: true` to wait until removal finishes.
```
10 changes: 7 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,13 @@ Keep examples aligned with the implemented API. Label test doubles and local
verification limits clearly. Verify changed examples before handoff and update
`examples/README.md` when adding a language.

Update project Markdown whenever APIs, layout, architecture, or dependencies
change. Write docs as current-state truth: present tense, remove outdated
sections, and verify links and commands against the repository.
Update project Markdown and `website/content/docs/` whenever APIs, layout,
architecture, or dependencies change. Write docs as current-state truth for
**end users and SDK callers** (not SDK builders): present tense, what to call
and what you get back, provider- and language-specific when behavior differs.
Remove outdated sections, and verify links and commands against the
repository. See `.cursor/rules/docs-sdk-user-audience.mdc` and
`.cursor/skills/docs-current-state/`.

## Development tooling

Expand Down
Loading
Loading