# Nullspace Full Docs Index

Use this index to discover the Nullspace private-beta documentation source.

## Start

- `/introduction` - product overview and feature map.
- `/quickstarts` - quickstart hub.
- `/quickstarts/first-machine` - first machine with Python.
- `/quickstarts/development-environment` - pip, venv, uv, and shell setup.
- `/quickstarts/recipes` - common tasks after the quickstart.
- `/use-cases/ci-cd` - GitHub Actions AI review and validation in a machine.
- `/status` - private-beta status and health checks.

## Concepts

- `/concepts/overview` - lifecycle primitives.
- `/concepts/create` - create.
- `/concepts/exec` - execute commands.
- `/concepts/hibernate` - hibernate.
- `/concepts/resume` - resume.
- `/concepts/fork` - fork.
- `/concepts/destroy` - destroy.

## Build

- `/build` - choose the Nullspace primitive for isolated developer workflows.

## Machines

- `/machines/overview` - machine runtime boundary and lifecycle entrypoint.
- `/machines/create-connect-list` - create, connect, list, inspect, cleanup.
- `/machines/lifecycle` - create, exec, hibernate, resume, fork, destroy.
- `/machines/persistence` - pause and resume.
- `/machines/auto-resume` - pause idle machines and wake them from SDK calls or public traffic.
- `/machines/snapshots` - snapshot management.
- `/machines/fork` - branch warm state.
- `/machines/metrics-timeouts` - metrics, timeout actions, capacity notes.

## Commands

- `/commands/overview` - run commands.
- `/commands/background` - background processes.
- `/commands/streaming` - streaming output.
- `/commands/processes` - stdin, logs, list, kill.

## Filesystem

- `/filesystem` - read, write, list, move, remove.
- `/filesystem/uploads` - direct and resumable uploads.
- `/filesystem/downloads` - read and signed download URLs.
- `/filesystem/search-watch` - search, replace, watch.

## Code Interpreter

- `/code-interpreter/overview` - stateful code execution.
- `/code-interpreter/contexts` - contexts and kernel state.
- `/code-interpreter/streaming` - stdout, stderr, results, artifacts, errors.
- `/code-interpreter/runs-artifacts` - async runs and artifacts.

## Templates

- `/templates/overview` - template feature map.
- `/templates/quickstart` - build and launch a reusable template.
- `/templates/how-it-works` - template build flow and refs.
- `/templates/user-workdir` - default user, workdir, and envs.
- `/templates/caching` - build cache controls.
- `/templates/defining` - builder steps.
- `/templates/base-images` - images and Dockerfiles.
- `/templates/private-registries` - private base image auth.
- `/templates/build` - foreground/background builds.
- `/templates/logging` - build logs and reconnecting.
- `/templates/start-ready` - start commands and readiness probes.
- `/templates/warm-pools` - template warm pools.
- `/guides/template-kernel-selection` - template and kernel compatibility guidance.
- `/templates/names` - names and namespaces.
- `/templates/tags-versioning` - tags, aliases, visibility, and deletion.
- `/templates/errors` - structured build errors.

## Use Cases

- `/use-cases/ci-cd` - GitHub Actions CI/CD with isolated pull request review and tests.

## Access

- `/access/overview` - choose PTY, SSH, and retained-machine debugging.
- `/access/pty` - interactive terminal sessions.
- `/access/ssh` - OpenSSH over certificate-backed relay access.
- `/access/debug-retained-machines` - inspect retained failed job and service machines.

## Desktop Environments

- `/desktop/overview` - desktop environment capability for agents and humans.
- `/desktop/automation` - screenshots, input, windows, clipboard, launch.
- `/desktop/viewer` - managed browser viewer.
- `/desktop/recordings` - screen recordings.

## Agents

- `/agents/overview` - local MCP, in-machine workspaces, Agent Deployments, and framework integrations.
- `/agents` - operational guidance for agents driving Nullspace.
- `/agents/primitives` - agent workspace and deployment object model.
- `/agents/deployments` - deploy a local agent project as a named job or service.
- `/agents/local-mcp` - connect local coding agents to Nullspace CLI tools through MCP.
- `/agents/agent-skills` - install Nullspace instructions for Codex and Claude Code.
- `/agents/codex` - Codex.
- `/agents/claude-code` - Claude Code.
- `/agents/amp` - Amp.
- `/agents/opencode` - OpenCode.
- `/agents/openai-agents-sdk` - OpenAI Agents SDK integration.
- `/agents/claude-agent-sdk` - Claude Agent SDK job deployment.
- `/agents/langgraph` - LangGraph service deployment.
- `/agents/langchain` - LangChain tool integration.
- `/agents/crewai` - CrewAI job deployment.
- `/agents/bring-your-own-agent` - custom agent integration.

## Volumes

- `/volumes/overview` - durable shared filesystems, behavior, capacity, and limits.
- `/volumes/managing-volumes` - create, list, inspect, field-select, refresh, and delete volumes.
- `/volumes/mounting-volumes` - create-time and runtime mounts, subpaths, read-only mounts, health, and remount.
- `/volumes/read-write` - direct reads, writes, batch writes, moves, chmod, search, replace, and watches.
- `/volumes/file-directory-metadata` - list, stat, existence checks, directory creation, search, and watch metadata.
- `/volumes/files` - direct volume files overview.
- `/volumes/upload-data` - upload files, directories, stdin streams, signed URLs, and resumable transfers.
- `/volumes/download-data` - download files, directories, archives, and signed URLs.
- `/volumes/transfers` - upload and download volume data.

## Networking And Security

- `/guides/api-keys` - API keys.
- `/networking/preview-urls` - signed preview URLs.
- `/networking/custom-preview-proxy` - customer-run reverse proxy targets with header preview tokens.
- `/networking/token-model` - API keys, edge preview tokens, continuation cookies, proxy tokens, traffic tokens, desktop viewer tokens, SSH credentials, and file transfer URLs.
- `/networking/access-control` - signed URLs, traffic tokens, host masking, outbound policy.
- `/networking/websockets` - WebSocket surfaces.
- `/guides/mount-bucket` - bucket mounts.
- `/guides/proxy-tunneling` - proxy tunneling.
- `/guides/share-machine-url` - share signed preview URLs.

## Observability

- `/observability/lifecycle-events` - event history and stream.
- `/observability/webhooks` - lifecycle webhooks.
- `/observability/monitor` - monitor stream and metrics.

## Examples

- `/examples` - examples index.
- `/examples/code-interpreter` - code interpreter.
- `/examples/agent` - agent workspace.
- `/examples/agent-deployment-job` - agent deployment job.
- `/examples/agent-deployment-service` - agent deployment service.
- `/examples/agent-deployment-openai-agents` - OpenAI Agents SDK job.
- `/examples/agent-deployment-claude-agent-sdk` - Claude Agent SDK job.
- `/examples/agent-deployment-langgraph-service` - LangGraph service.
- `/examples/agent-deployment-crewai-job` - CrewAI job.
- `/examples/agent-deployment-typescript-service` - TypeScript service.
- `/examples/fork` - fork.
- `/examples/port-forwarding` - preview URL.
- `/examples/custom-preview-proxy` - custom preview proxy samples.
- `/examples/template-build` - template build.
- `/examples/template-warm-pools` - template warm pools example.
- `/examples/resumable-upload` - resumable upload.
- `/examples/desktop-viewer` - desktop viewer.
- `/examples/lifecycle-webhook` - lifecycle webhook.
- `/examples/shared-volume` - shared volume.

## Reference

- `/sdk-reference` - Python SDK surface map.
- `/reference/config` - SDK and CLI configuration precedence.
- `/reference/python-sdk/machine` - machine object reference.
- `/reference/python-sdk/commands` - commands and processes object reference.
- `/reference/python-sdk/filesystem` - filesystem object reference.
- `/reference/python-sdk/templates` - templates object reference.
- `/reference/python-sdk/volumes` - volumes object reference.
- `/reference/python-sdk/code-interpreter` - code interpreter object reference.
- `/reference/python-sdk/desktop-pty` - desktop and PTY object reference.
- `/reference/python-sdk/lifecycle-monitor` - lifecycle and monitor object reference.
- `/reference/python-sdk/errors-types` - errors and types object reference.
- `/reference/cli` - CLI command tree.
- `/reference/cli-schema` - machine-readable CLI command metadata.
- `/reference/git` - Git helper API.
- `/reference/hosted-endpoints` - current hosted private-beta endpoint values.
- `/reference/env-vars` - user-facing env vars.
- `/reference/websocket-protocol` - WebSocket surfaces and protocol pointer.
- `/guides/index` - all guides index for older links.
- `/api-reference` - OpenAPI-generated API reference.
- `/changelog` - changelog.