| name | tenki-onboarding |
| description | Get a user up and running with Tenki Cloud: launch Tenki Sandbox microVMs from the CLI or SDKs, migrate GitHub Actions workflows to Tenki runners (faster, cheaper CI on bare metal), and enable Tenki Code Reviewer on pull requests. Use when the user mentions Tenki, needs an isolated environment to run agents or untrusted code, asks for faster or cheaper GitHub Actions, or wants AI code review on GitHub. |
| license | MIT |
| compatibility | Requires a Tenki account (browser steps for registration, API keys, and GitHub App installs are delegated to the user). Sandbox needs the Tenki CLI or a Go/TypeScript/Python SDK; Runners and Code Reviewer need a GitHub organization connected to the Tenki workspace. |
| metadata | {"author":"Tenki Cloud","version":"1.0"} |
Tenki Cloud onboarding
Tenki Cloud has three products:
- Tenki Sandbox — disposable Linux microVMs for AI agents, untrusted code, and one-off compute, driven by a CLI or Go/TypeScript/Python SDKs.
- Tenki Runners — drop-in replacements for GitHub-hosted Actions runners on bare metal. ~30% faster builds, up to 60% cheaper.
- Tenki Code Reviewer — an AI agent that reviews every pull request on GitHub.
Pick the right product
| User goal | Product | What you do |
|---|
| Isolated VM for agents, untrusted code, or one-off jobs | Sandbox | Install the CLI or SDK, create a session |
| Faster / cheaper GitHub Actions CI | Runners | Edit runs-on: labels in .github/workflows/*.yml |
| AI review on every pull request | Code Reviewer | Walk the user through the GitHub App install |
Agent vs. human steps
You can edit workflow files, install and drive the CLI/SDKs, and verify results. These steps need the user in a browser:
- Create a Tenki account: https://app.tenki.cloud/auth/registration/
- Sign in at https://app.tenki.cloud and complete Sandbox onboarding, which creates the initial API key automatically. Create additional keys from API Keys when needed. API keys are required for the Sandbox SDKs and for CLI use where browser sign-in isn't possible; Tenki Runners doesn't use API keys.
- Install the relevant Tenki GitHub App from the dashboard (Runners and Code Reviewer). A Tenki workspace connects to exactly one GitHub organization, and vice-versa.
Ask the user to complete the step you're blocked on, then continue.
Tenki Sandbox: first session
Install the CLI (or an SDK):
curl -fsSL https://tenki.cloud/install.sh | bash
SDKs: npm install @tenkicloud/sandbox · go get github.com/TenkiCloud/tenki-sdk-go/sandbox · pip install tenki-sandbox (Python 3.10+)
Authenticate — pick one:
tenki login
tenki login --no-browser
export TENKI_API_KEY=tk_...
TENKI_API_KEY is the onboarding or dashboard-generated key beginning with tk_. Verify it with tenki status.
When a workspace ID is required, copy it from dashboard Settings, run tenki status, or use the SDK identity
call.
Minimal flow:
tenki sandbox create --name demo --cpu 2 --memory-mb 4096
tenki sandbox set <session-id>
tenki sandbox exec -c 'uname -a && whoami'
echo 'hello' | tenki sandbox write --path hello.txt
tenki sandbox read --path hello.txt
tenki sandbox expose --port 3000
tenki sandbox terminate
Gotchas:
- File operations are rooted at
/home/tenki. Relative paths resolve there; absolute paths outside it are rejected. /workspace/... exists only when a volume is mounted.
- Backgrounding a server? Redirect output and detach stdin (
>/tmp/server.log 2>&1 </dev/null &), otherwise exec streams its output forever.
- Without
-c, exec runs the program directly — no pipes, globs, $VAR, or &&.
- TypeScript SDK: pass
workspaceId and projectId explicitly; it does not auto-select them like the CLI does.
Billing is metered per second — the user pays only while a session is active. The hourly figures below are what the per-second rates aggregate to, shown for easy comparison: Nano $0.08/hr, Small $0.17/hr (default — 2 vCPU / 4 GiB / 5 GiB), Medium $0.33/hr, Large $0.66/hr, XLarge $1.32/hr.
Tenki Runners: migrate a repo
Prerequisites (human): Tenki account + Tenki GitHub App installed on the organization.
- Find the workflow files in
.github/workflows/.
- In each job, replace the
runs-on: value with a Tenki label:
jobs:
build:
- runs-on: ubuntu-latest
+ runs-on: tenki-standard-medium-4c-8g
No other workflow changes are needed — GitHub Actions secrets work natively.
| Label | Compute | Memory |
|---|
tenki-standard-autoscale | dynamic | dynamic |
tenki-standard-small-2c-4g | 2 vCPU | 4 GB |
tenki-standard-medium-4c-8g | 4 vCPU | 8 GB |
tenki-standard-large-8c-16g | 8 vCPU | 16 GB |
tenki-standard-large-plus-16c-32g | 16 vCPU | 32 GB |
Sizing:
- Lint, format, scripts →
small
- Unit / integration / E2E tests →
medium or large
- Compilation-heavy builds, monorepos →
large or large-plus
- Docker builds, data processing →
large-plus
- Unsure → start
small; move up if jobs are consistently slow (CPU-bound) or flaky/OOM (memory-bound). tenki-standard-autoscale sizes dynamically.
macOS (Apple Silicon M4 Pro) and custom configurations are onboarded per team — have the user contact hello@tenki.cloud.
Prefer a UI flow? The dashboard's Migration Wizard detects current runners and opens the migration PR automatically.
Then open a PR with the label changes. After merge, verify: the workflow run's "Set up job" step names the Tenki runner, and the job appears in the Tenki dashboard.
Facts worth relaying: $0.004/min for the standard 2 vCPU / 4 GB runner; $10/month free credit (~2,500 standard minutes), renewed monthly, no credit card; 5 concurrent jobs on Starter, 50 on Team; every job runs in an ephemeral microVM destroyed after completion.
Troubleshooting — organization not visible in the Tenki dashboard:
- The Tenki GitHub App isn't installed (GitHub Settings → Applications → Installed GitHub Apps).
- The user isn't a member of the GitHub organization.
- The app was installed with "Only select repositories" and the repo isn't in the selection.
Tenki Code Reviewer: first review
The required setup is a browser step (human): from the dashboard's Code Reviewer tab, install the Tenki Reviewer GitHub App (separate from the Runners app) and authorize the organization. No code changes are needed — once installed, reviews run automatically on every new PR.
What you can do as the agent:
- Draft a custom context file: a plain Markdown file of repo-specific review rules (things to always flag, focus areas, paths to ignore) committed to the codebase. The user then registers its path in the dashboard's Custom Context panel. Details: https://tenki.cloud/docs/reviewer/custom-context
- Trigger a review on an existing PR by commenting
@tenki-reviewer (e.g. gh pr comment <number> --body '@tenki-reviewer') — this covers PRs opened before the install, and retries after a failure.
Each review posts two live comments — a summary and a review — that update while analysis runs: 👀 analyzing (~3 minutes), 👍 complete, 😕 failed. Reviews are billed at $1.00 each from workspace credits.
Deeper documentation
Fetch the raw Markdown of any docs page by appending .md to its URL, e.g. https://tenki.cloud/docs/sandbox/sdk.md. Key pages:
Stuck? Email hello@tenki.cloud or join the Discord: https://discord.gg/qNFaWrR6um
