Namespace

https://namespace.so/docs
Admin
Namespace is a cloud compute platform that accelerates developer workflows by providing fast...
Tokens:378,223
Snippets:4,707
Trust Score:8.2
Update:3 hours ago
Show doc for...
Tokens:
Raw
### nsc install example with --dir

Source: https://namespace.so/docs/reference/cli/install

Example command that installs nsc to /usr/local/bin. The --dir flag overrides the default installation directory (~/.local/bin).

```bash
nsc install --dir /usr/local/bin
```

--------------------------------

### Start a container during creation

Source: https://namespace.so/docs/reference/typescript-sdk/compute/manage

Example showing how to start a container as part of the instance creation request.

```APIDOC
## Start a container during creation

### Description
Linux instances can start containers as part of the creation request.

### Example
```typescript
import { timestampFromDate } from "@bufbuild/protobuf/wkt";

const instance = await client.compute.createInstance({
  shape: {
    os: "linux",
    machineArch: "amd64",
    virtualCpu: 2,
    memoryMegabytes: 4 * 1024,
  },
  documentedPurpose: "Run nginx",
  deadline: timestampFromDate(new Date(Date.now() + 30 * 60 * 1000)),
  containers: [
    {
      name: "nginx",
      imageRef: "nginx",
    },
  ],
});
```
```

--------------------------------

### Install and start nixcache on the builder

Source: https://namespace.so/docs/integrations/nix

Runs a heredoc over SSH to install nixcache and start the proxy. The quoted heredoc keeps environment variables on the remote instance so the cache directory belongs to the builder. The proxy uses the instance's credentials and defaults to -cache-upstream=persist.

```bash
ssh <id>@ssh.ord2.namespace.so 'bash -s' <<'EOF'
set -eu
curl -fsSL https://public.namespaceblobs.com/nixcache/install.sh | sh

cache_root="${NSC_CACHE_PATH:-${XDG_CACHE_HOME:-$HOME/.cache}}"
~/.local/bin/nixcache -cache_dir "$cache_root/nixcache"
EOF
```

--------------------------------

### Setup Go with actions/setup-go

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Installs Go using the setup-go action. Disables its built-in cache to enable the `go` cache mode.

```yaml
- name: Setup Go
  uses: actions/setup-go@v5
  with:
    go-version-file: go.mod
    cache: false

```

--------------------------------

### Setup golangci-lint with install-mode none

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Alternative setup for golangci-lint that skips the install step, to be used after the cache is set up. Uses version 2.8 and install-mode none.

```yaml
- name: Setup golangci-lint
  uses: golangci/golangci-lint-action@v8
  with:
    version: 2.8
    install-mode: none

```

--------------------------------

### Example: Go cache with cache: go

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Workflow example using the `cache: go` mode. Requires Go to be installed before the cache action runs, otherwise the step fails. Must run after checkout.

```yaml
name: Tests
jobs:
  tests:
    runs-on: namespace-profile-my-profile

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Install Go
        uses: actions/setup-go@v6
        with:
          cache: false # Skip remote GitHub caching

      - name: Set up Go cache
        uses: namespacelabs/nscloud-cache-action@v1
        with:
          cache: go

      - name: Go tests
        run: go test ./...
```

--------------------------------

### Setup Bun with oven-sh/setup-bun

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Installs Bun using the official setup action. No additional configuration is needed to enable the `bun` cache mode.

```yaml
- name: Setup Bun
  uses: oven-sh/setup-bun@v2

```

--------------------------------

### Example output of nsc cache sccache setup

Source: https://namespace.so/docs/reference/cli/sccache-setup

Run the setup command to print the required environment variables. The output shows SCCACHE_WEBDAV_ENDPOINT, SCCACHE_WEBDAV_KEY_PREFIX, and SCCACHE_WEBDAV_TOKEN.

```bash
nsc cache sccache setup
```

```bash
SCCACHE_WEBDAV_ENDPOINT=https://cache.namespace.so:8080
SCCACHE_WEBDAV_KEY_PREFIX=sccache/my-cache/
SCCACHE_WEBDAV_TOKEN=scc_token_abc123...
```

--------------------------------

### services.get() example

Source: https://namespace.so/docs/reference/typescript-sdk/devbox/services

Retrieves a single service by ID or name using services.get(). The example fetches a Devbox named 'sdk-example' and then gets a service named 'web', logging its process state or 'not started' if undefined.

```typescript
const devbox = await client.devboxes.get("sdk-example");
const service = await devbox.services.get("web");
console.log(service.process?.state ?? "not started");
```

--------------------------------

### Start a test run with executions.start()

Source: https://namespace.so/docs/reference/typescript-sdk/devbox/commands

Example showing how to start a command without waiting for it to finish, then wait for the result using the returned handle.

```typescript
const devbox = await client.devboxes.get("sdk-example");
const execution = await devbox.executions.start(["npm", "test"], {
  cwd: "/workspace",
});
console.log(`Started ${execution.id}`);
const result = await execution.wait();
console.log(result.exitCode);
```

--------------------------------

### services.list() example

Source: https://namespace.so/docs/reference/typescript-sdk/devbox/services

Lists all services on a Devbox using services.list(). The example fetches a Devbox named 'sdk-example' and iterates over the services, logging each service's name and process state or 'not started' if undefined.

```typescript
const devbox = await client.devboxes.get("sdk-example");
const services = await devbox.services.list();
for (const service of services) {
  console.log(service.name, service.process?.state ?? "not started");
}
```

--------------------------------

### Install Nix with cachix/install-nix-action

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Install Nix after setting up the nix cache. The `/nix` store will already be mounted from the cache. The example includes extra Nix configuration for access tokens and system features.

```yaml
- name: Install Nix
  uses: cachix/install-nix-action@v31
  with:
    extra_nix_config: |
      access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
      system-features = kvm nixos-test

```

--------------------------------

### Setup PHP with shivammathur/setup-php

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Installs PHP using the setup-php action. No additional configuration is needed to enable the `composer` cache mode.

```yaml
- name: Setup PHP
  uses: shivammathur/setup-php@v2
  with:
    php-version: '8.3'

```

--------------------------------

### Setup Java with actions/setup-java

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Installs Java using the setup-java action. Disables its built-in cache by setting `cache: ''` to enable the `gradle` cache mode.

```yaml
- name: Setup Java
  uses: actions/setup-java@v5
  with:
    distribution: temurin
    java-version: '21'
    cache: ''

```

--------------------------------

### Output of token creation command

Source: https://namespace.so/docs/integrations/gradle

Example output showing the token ID, name, expiration, and the setup command to use with the token.

```text
Token ID:    tok_...
Name:        gradle-cache--hvc6lmg
Expires At:  2026-01-10T17:51:49+01:00

You can set up your gradle cache config with:
  nsc cache gradle setup --token token.json
```

--------------------------------

### Example: Cache arbitrary files with path

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Workflow example using the `path` input to cache arbitrary directories. Does not require the toolchain to be installed beforehand.

```yaml
name: Tests
jobs:
  tests:
    runs-on: namespace-profile-my-profile

    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Install Go
        uses: actions/setup-go@v6
        with:
          cache: false # Skip remote GitHub caching

      - name: Set up Go cache
        uses: namespacelabs/nscloud-cache-action@v1
        with:
          path: |
            /home/runner/.cache/go-build
            /home/runner/go/pkg/mod

      - name: Go tests
        run: go test ./...
```

--------------------------------

### Setup Deno with denoland/setup-deno

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Installs Deno using the setup-deno action. Disables its built-in cache to enable the `deno` cache mode.

```yaml
- name: Setup Deno
  uses: denoland/setup-deno@v2
  with:
    cache: false

```

--------------------------------

### Start sccache with token

Source: https://namespace.so/docs/integrations/sccache

Exports the generated environment variables from the token setup and starts the sccache server. Credentials are bound to the user; if the user is removed or permissions reduced, the token becomes invalid.

```bash
export $(nsc cache sccache setup --token token.json --cache_name default)
sccache --start-server
```

--------------------------------

### Setup golangci-lint with golangci/golangci-lint-action

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

Installs golangci-lint with version 2.8, install-only mode, and skip-cache enabled. This is the first step to enable the `golangci-lint` cache mode.

```yaml
- name: Setup golangci-lint
  uses: golangci/golangci-lint-action@v8
  with:
    version: 2.8
    install-only: true
    skip-cache: true

```

--------------------------------

### Linux host to Linux workers setup

Source: https://namespace.so/docs/bazel/execution

Clones the Bazel examples repository and sets up Namespace for Linux workers. Actions without explicit platform properties are routed to Linux workers.

```bash
git clone https://github.com/bazelbuild/examples.git
cd examples/cpp-tutorial/stage3

nsc bazel setup --bazelrc=~/.namespace.bazelrc --key=examples-linux
bazel --bazelrc=~/.namespace.bazelrc build //...
```

--------------------------------

### Buildkite step with turborepo caching

Source: https://namespace.so/docs/integrations/turborepo

Runs the setup command at the start of a Buildkite step and exports the configuration. --mask-buildkite redacts the token from logs and requires buildkite-agent on PATH.

```yaml
steps:
  - label: "Build"
    commands:
      - export $(nsc cache turborepo setup --team main --mask-buildkite)
      - turbo build
```

--------------------------------

### Output of nsc cache turborepo setup

Source: https://namespace.so/docs/integrations/turborepo

Example output showing the environment variables that `turbo` needs: TURBO_API, TURBO_TEAM, and TURBO_TOKEN.

```text
TURBO_API=https://turbo.cache.namespaceapi.com
TURBO_TEAM=main
TURBO_TOKEN=nsct_...
```

--------------------------------

### Initialize access to Namespace with nscloud-setup

Source: https://namespace.so/docs/federation/github-actions

After granting permissions, use the namespacelabs/nscloud-setup action to allow subsequent steps to access Namespace resources. This example shows a complete workflow with checkout and setup steps.

```yaml
name: Example workflow
permissions:
  id-token: write # This is required for federation using OpenID Connect
  contents: read # This is required for actions/checkout
jobs:
  test:
    name: Preprod nodes test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Configure access to Namespace
        uses: namespacelabs/nscloud-setup@v0
      - run: |
          nsc bazel setup --remote=false --bazelrc /etc/bazel.bazelrc
```

--------------------------------

### Complete example: create and wait for instance

Source: https://namespace.so/docs/reference/typescript-sdk/compute

Complete example combining all steps: create a client, create a Linux instance, print its ID, and wait for it to run.

```typescript
import { timestampFromDate } from "@bufbuild/protobuf/wkt";
import { createComputeClient } from "@namespacelabs/sdk/api/compute";

const client = createComputeClient();

const instance = await client.compute.createInstance({
  shape: {
    os: "linux",
    machineArch: "amd64",
    virtualCpu: 2,
    memoryMegabytes: 4 * 1024,
  },
  documentedPurpose: "TypeScript SDK example",
  deadline: timestampFromDate(new Date(Date.now() + 30 * 60 * 1000)),
});

const instanceId = instance.metadata!.instanceId;
console.log(`Created instance: ${instanceId}`);

await client.compute.waitInstanceSync(
  { instanceId },
  { timeoutMs: 10 * 60 * 1000 },
);

console.log("Instance is running");
```

--------------------------------

### nsc registry default-expiration get example

Source: https://namespace.so/docs/reference/cli/registry-default-expiration

Example output of the get subcommand, showing the current default expiration configuration.

```bash
nsc registry default-expiration get

Revision:             4
Default Expiration:   5h0m0s
```

--------------------------------

### Set up JDK and Android SDK

Source: https://namespace.so/docs/integrations/android-emulators

Install JDK 17 (Temurin) and the Android SDK using `actions/setup-java` and `android-actions/setup-android`. These steps are required before running the emulator.

```yaml
- name: Set up JDK
  uses: actions/setup-java@v4
  with:
    distribution: temurin
    java-version: 17

- name: Set up Android SDK
  uses: android-actions/setup-android@v3
```

--------------------------------

### Complete devbox.yaml example

Source: https://namespace.so/docs/reference/devbox-cli/spec-file

Full example configuration showing all supported fields: name, image, size, access_mode, volume_size_gb, auto_stop_idle_timeout, privileged, repository, sessions, integrations, env, and network_policy.

```yaml
name: my-devbox
image: builtin:default
size: M
access_mode: private
volume_size_gb: 100
auto_stop_idle_timeout: 30m
privileged: false
repository:
  url: github.com/my-org/my-repo
  ref: main
sessions:
  - name: server
    command: npm run dev
  - name: tests
    command: npm test -- --watch
integrations:
  github:
    share_auth: true
  tailscale:
    spec: corp
env:
  - name: APP_ENV
    value: production
  - name: GITHUB_TOKEN
    from_secret_id: my-github-token-id
network_policy:
  egress_domains:
    - "*.github.com"
    - api.openai.com
```

--------------------------------

### Install fish completion

Source: https://namespace.so/docs/reference/cli/completion

Installs the fish completion script to ~/.config/fish/completions/nsc.fish. Start a new shell after installing.

```fish
nsc completion fish > ~/.config/fish/completions/nsc.fish
```

--------------------------------

### Install Bash completion on Linux

Source: https://namespace.so/docs/reference/cli/completion

Installs the Bash completion script to /etc/bash_completion.d/nsc on Linux. Start a new shell after installing.

```bash
nsc completion bash > /etc/bash_completion.d/nsc
```

--------------------------------

### devbox desktop type example

Source: https://namespace.so/docs/reference/devbox-cli/desktop

Types the text 'hello world' into the focused application.

```bash
devbox desktop type my-devbox --text "hello world"
```

--------------------------------

### Install Zsh completion on Linux

Source: https://namespace.so/docs/reference/cli/completion

Installs the Zsh completion script to the first directory in fpath on Linux. Start a new shell after installing.

```zsh
nsc completion zsh > "${fpath[1]}/_nsc"
```

--------------------------------

### Install Bash completion on macOS

Source: https://namespace.so/docs/reference/cli/completion

Installs the Bash completion script to the brew prefix directory on macOS. Start a new shell after installing.

```bash
nsc completion bash > $(brew --prefix)/etc/bash_completion.d/nsc
```

--------------------------------

### Example workflow with nscloud-setup

Source: https://namespace.so/docs/reference/github-actions/nscloud-setup

Example GitHub Actions workflow that uses nscloud-setup to create an ephemeral Kubernetes cluster. Requires id-token: write and contents: read permissions.

```yaml
jobs:
  deploy:
    name: Ephemeral cluster
    runs-on: ubuntu-latest
    # These permissions are needed to interact with GitHub's OIDC Token endpoint.
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@v4
      - uses: namespacelabs/nscloud-setup@v0
      - name: Create an ephemeral Kubernetes cluster
        run: |
          nsc cluster create
```

--------------------------------

### Example workflow using setup-turbocache

Source: https://namespace.so/docs/reference/github-actions/setup-turbocache

Example GitHub Actions workflow that checks out code, sets up caching with setup-turbocache, and runs turbo build. The job runs on namespace-profile-default.

```yaml
jobs:
  build:
    runs-on: namespace-profile-default

    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Set up caching
        uses: namespace-actions/setup-turbocache@v0
      - name: Go turbo
        run: turbo build
```

--------------------------------

### Install Zsh completion on macOS

Source: https://namespace.so/docs/reference/cli/completion

Installs the Zsh completion script to the brew prefix share/zsh/site-functions directory on macOS. Start a new shell after installing.

```zsh
nsc completion zsh > $(brew --prefix)/share/zsh/site-functions/_nsc
```

--------------------------------

### nsc instance upload example and output

Source: https://namespace.so/docs/reference/cli/instance-upload

Example command uploading a configuration file to an instance, followed by the expected output. The output confirms the upload and shows the file size and duration.

```bash
nsc instance upload 85a32emcg99ii ./config.yaml /etc/app/config.yaml
```

```text
Uploaded config.yaml (12 KiB) to /etc/app/config.yaml. Took 1.2s.
```

--------------------------------

### Example workflow using nscloud-setup-buildx-action

Source: https://namespace.so/docs/reference/github-actions/nscloud-setup-buildx-action

A complete GitHub Actions job that checks out the repository, sets up Namespace, configures Docker buildx with the action, and builds and pushes an image. Requires the id-token and contents permissions for OIDC.

```yaml
jobs:
  docker:
    runs-on: ubuntu-latest
    # These permissions are needed to interact with GitHub's OIDC Token endpoint.
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@v4
      - uses: namespacelabs/nscloud-setup@v0
      - name: Configure Docker to use Namespace Remote Builders
        uses: namespacelabs/nscloud-setup-buildx-action@v0
      - name: Build and push
        uses: docker/build-push-action@v5
        with:
          push: true
          tags: user/app:latest
```

--------------------------------

### Example: nsc auth exchange-aws-cognito-token

Source: https://namespace.so/docs/reference/cli/auth-exchange-aws-cognito-token

Example command that exchanges AWS credentials for a Namespace token. Replace <region>, <guid>, and <workspace-id> with actual values.

```bash
nsc auth exchange-aws-cognito-token \
  --aws_region <region> \
  --identity_pool <guid> \
  --tenant_id <workspace-id>
```

--------------------------------

### Usage: nsc cache gradle setup

Source: https://namespace.so/docs/reference/cli/gradle-cache-setup

Shows the full command syntax with all available options. Use this to understand the command's parameters.

```bash
nsc cache gradle setup [--cache_name <name>] \
  [--init-gradle <path>] \
  [--output <plain|json>] \
  [--push] \
  [--site <site>] \
  [--token <path>] \
  [--user]
```

--------------------------------

### Output for listing all repositories

Source: https://namespace.so/docs/reference/cli/registry-list

Example output showing repository names and last push times.

```text
Repository Name       Last Push
myapp                 2024-01-15T10:30:00Z
backend-service       2024-01-14T15:45:30Z
```

--------------------------------

### executions.get()

Source: https://namespace.so/docs/reference/typescript-sdk/devbox/commands

Reattaches to an execution by ID, for example from a different process than the one that started it.

```APIDOC
## executions.get()

### Description
Reattaches to an execution by ID, for example from a different process than the one that started it.

### Method
SDK Method

### Signature
`executions.get(id: string, options?: OperationOptions): Promise<DevboxExecution>`

### Parameters
#### id (string) - Required
The execution ID returned by `executions.start()` or `executions.startShell()`. The ID must not be empty.

#### options (OperationOptions) - Optional
Supports `signal` and `timeoutMs`. See Shared operation options.

### Return Value
Resolves with a `DevboxExecution` handle. Rejects with `ExecutionNotFoundError` when the Devbox agent no longer retains an execution with that ID.

### Example
```typescript
const devbox = await client.devboxes.get("sdk-example");
const executionId = "execution-id";
const execution = await devbox.executions.get(executionId);
console.log(await execution.status());
```
```

--------------------------------

### Setup Mise with built-in cache disabled

Source: https://namespace.so/docs/reference/github-actions/nscloud-cache-action

After setting up the mise cache, setup Mise and install packages, making sure to disable its built-in cache with `cache: false`.

```yaml
- name: Setup mise
  uses: jdx/mise-action@v2
  with: 
    cache: false

```

--------------------------------

### Local shell setup with nsc cache turborepo setup

Source: https://namespace.so/docs/integrations/turborepo

Exports the environment variables printed by `nsc cache turborepo setup` and runs `turbo build` to use the shared cache from a local machine. Requires the Namespace CLI to be installed.

```bash
export $(nsc cache turborepo setup --team main)
turbo build
```

--------------------------------

### Get a URL by name

Source: https://namespace.so/docs/reference/devbox-cli/url

Example retrieving the exposed URL named 'web' on Devbox 'main'.

```bash
devbox url get main --name web
```

--------------------------------

### Start a shell script with executions.startShell()

Source: https://namespace.so/docs/reference/typescript-sdk/devbox/commands

Starts a shell script without waiting for completion. The script is evaluated with `<shell> -lc <script>`. The example uses cwd option to set the working directory.

```typescript
const devbox = await client.devboxes.get("sdk-example");
const execution = await devbox.executions.startShell("npm install && npm run build", {
  cwd: "/workspace",
});
console.log(execution.id);
```

--------------------------------

### devbox setup-github usage syntax

Source: https://namespace.so/docs/reference/devbox-cli/setup-github

Shows the command-line syntax for devbox setup-github. Use [name] to specify a Devbox and [flags] for additional options.

```bash
devbox setup-github [name] [flags]
```

--------------------------------

### Output: Listening on 127.0.0.1:8080

Source: https://namespace.so/docs/reference/cli/instance-port-forward

Expected output after running the example command, indicating the local port is listening.

```text
Listening on 127.0.0.1:8080
```

--------------------------------

### Create a Linux Devbox from an image

Source: https://namespace.so/docs/reference/typescript-sdk/devbox/manage

Creates a Devbox using the TypeScript SDK. The Devbox starts by default; set start: false to create without activating. The example uses the built-in image 'builtin:default'.

```typescript
import { createDevboxClient } from "@namespacelabs/sdk/devbox";

const client = createDevboxClient();

const devbox = await client.devboxes.create({
  name: "sdk-example",
  imageName: "builtin:default",
});
```

--------------------------------

### Install Nix on the remote instance using Determinate installer

Source: https://namespace.so/docs/integrations/nix

SSHes into the instance and installs Nix with the Determinate installer. Bare instances run as root, so sudo is not needed. With --init none, the daemon is left stopped and may report a missing daemon socket during self-test.

```bash
ssh <id>@ssh.ord2.namespace.so "curl -fsSL https://install.determinate.systems/nix | sh -s -- install linux --determinate --init none --no-confirm"
```

--------------------------------

### nsc github base-image describe

Source: https://namespace.so/docs/reference/cli/github-base-image-describe

Show details for a specific GitHub runner base image. The command prints the full details of a single base image, identified by its label (for example `ubuntu-26.04`). The output includes the image reference, the operating system, the enabled features, and the complete list of installed packages with their versions. Pass `-o json` to get a machine-readable representation that is easy to diff between two images.

```APIDOC
## nsc github base-image describe

### Description
Show details for a specific GitHub runner base image. The command prints the full details of a single base image, identified by its label (for example `ubuntu-26.04`). The output includes the image reference, the operating system, the enabled features, and the complete list of installed packages with their versions. Pass `-o json` to get a machine-readable representation that is easy to diff between two images.

### Usage
```
nsc github base-image describe <label> [flags]
```

### Arguments
#### <label>
- **label** (string) - Required - The label of the base image to describe, for example `ubuntu-26.04`. Use `nsc github base-image list` to see the available labels.

### Optional Flags
#### -o, --output string
- **output** (string) - Optional - Output format. Default: `plain`. Supported values: `plain`, `json`.

#### --canary
- **canary** (boolean) - Optional - Fetch the canary/staging image instead of the production image.

### Examples
**Describe a base image:**
```
nsc github base-image describe ubuntu-26.04
```

**Describe a base image as JSON:**
```
nsc github base-image describe ubuntu-26.04 -o json
```

**Diff the contents of two base images:**
```
diff \
  <(nsc github base-image describe ubuntu-24.04 -o json) \
  <(nsc github base-image describe ubuntu-26.04 -o json)
```

```

--------------------------------

### Test the installation with nix run

Source: https://namespace.so/docs/integrations/nix

Runs a package on the builder to test the installation. Nix uses the builder's local proxy for substitution, falling back to cache.nixos.org on a shared-cache miss.

```bash
ssh <id>@ssh.ord2.namespace.so nix run nixpkgs#hello
```

--------------------------------

### Example: nsc auth generate-dev-token

Source: https://namespace.so/docs/reference/cli/auth-generate-dev-token

Generates a development token when logged in. The output is a token string starting with 'nsct_'.

```bash
nsc auth generate-dev-token
```

```text
nsct_eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWUsImlhdCI6MTUxNjIzOTAyMn0.tyh-VfuzIxCyGYDlkBA7DfyjrqmSHu6pQ2hoZuFqUSLPNY2N0mpHb3nk5K17HWP_3cYHBw7AhHale5wky6-sVA
```

--------------------------------

### Configure cache access and start sccache

Source: https://namespace.so/docs/integrations/sccache

Exports environment variables from `nsc cache sccache setup --cache_name default` and starts the sccache server. Credentials are short-lived, suitable for CI runners and authenticated shells.

```bash
export $(nsc cache sccache setup --cache_name default)
sccache --start-server
```

--------------------------------

### Example in Buildkite

Source: https://namespace.so/docs/reference/cli/cache-turborepo-setup

Exports the configuration and runs turbo build, with the token masked by Buildkite.

```bash
export $(nsc cache turborepo setup --team main --mask-buildkite)
turbo build
```

--------------------------------

### Create a Linux instance

Source: https://namespace.so/docs/reference/typescript-sdk/compute

Create a Linux instance with 2 vCPUs and 4 GiB of memory, with a 30-minute deadline. The deadline releases the instance after 30 minutes.

```typescript
import { timestampFromDate } from "@bufbuild/protobuf/wkt";

const instance = await client.compute.createInstance({
  shape: {
    os: "linux",
    machineArch: "amd64",
    virtualCpu: 2,
    memoryMegabytes: 4 * 1024,
  },
  documentedPurpose: "TypeScript SDK example",
  deadline: timestampFromDate(new Date(Date.now() + 30 * 60 * 1000)),
});
```

--------------------------------

### Example: nsc bazel invocation list --since 24h

Source: https://namespace.so/docs/reference/cli/bazel-invocation-list

Lists Bazel invocations started within the last 24 hours. This is useful for finding an invocation ID to investigate further, for example with 'nsc bazel invocation report'.

```bash
nsc bazel invocation list --since 24h
```

--------------------------------

### Agent prompt to install devbox skill and create a devbox

Source: https://namespace.so/docs/devbox/cli

Give this prompt to a coding agent to automate the setup: it installs the namespacelabs/agent-skills skill and follows it to create a Devbox. You will need to complete the login in your browser when the agent reaches that step.

```text
install namespacelabs/agent-skills then create a devbox
```

--------------------------------

### Usage: nsc docker buildx setup

Source: https://namespace.so/docs/reference/cli/docker-buildx-setup

Shows the command syntax for 'nsc docker buildx setup' with all available options.

```bash
nsc docker buildx setup [--name <name>] [--state <path>] [--tag <tag>] [--background] [--create_at_startup] [--force_cleanup] [--use]
```

--------------------------------

### ServiceNotFoundError

Source: https://namespace.so/docs/reference/typescript-sdk/devbox/errors

Error thrown when the Devbox agent has no service matching the supplied ID or name. It appears from the `devbox.services` methods that take a service reference: `get()`, `start()`, `stop()`, `delete()`, and `logs()`. `get()` and `logs()` match names of user-owned services only.

```APIDOC
## ServiceNotFoundError

### Description
The Devbox agent has no service matching the supplied ID or name. It appears from the `devbox.services` methods that take a service reference: `get()`, `start()`, `stop()`, `delete()`, and `logs()`. `get()` and `logs()` match names of user-owned services only.

### Class
`ServiceNotFoundError` extends `DevboxError`

### Properties
- **ref** (string) - required - The service ID or name that was not found.

```

--------------------------------

### Example in GitHub Actions

Source: https://namespace.so/docs/reference/cli/cache-turborepo-setup

Appends the generated configuration to $GITHUB_ENV so subsequent steps pick it up.

```bash
nsc cache turborepo setup --team main --mask-github-actions >> "$GITHUB_ENV"
```

--------------------------------

### Create service with CLI

Source: https://namespace.so/docs/devbox/services

Create a service named 'web' that runs 'pnpm dev'.

```bash
devbox service create my-devbox --name web -- pnpm dev
```

--------------------------------

### nsc instance report example writing to stdout

Source: https://namespace.so/docs/reference/cli/instance-report

Generates a report starting at the specified time and writes it to stdout using --out -.

```bash
nsc instance report --start 2026-05-11T11:00:00Z --out -
```

--------------------------------

### Install and use devbox

Source: https://namespace.so/docs/reference/cli

Install devbox via curl, log in, create a Devbox, and open a shell. Requires a Devbox account.

```bash
curl -fsSL get.namespace.so/devbox/install.sh | bash
devbox login

# Create a Devbox, then open a shell in it
devbox create --name my-devbox
devbox ssh my-devbox
```

--------------------------------

### Create a macOS Devbox with CLI

Source: https://namespace.so/docs/devbox/lifecycle

Use `--platform macos` and pick a macOS image.

```bash
devbox create --platform macos --image tahoe
```

--------------------------------

### Create a Devbox with CLI prompts

Source: https://namespace.so/docs/devbox/lifecycle

Run `devbox create` to be prompted for each value.

```bash
devbox create
```
Tokens:
Raw