Skip to content

Repository files navigation

aibox

aibox

Turn one project contract into a reproducible, AI-ready workspace.

Status: usable project License: MIT Docs


Note

Maturity: usable project — active development. The maintained v0.x line supports Linux containers on Docker, Podman, and OrbStack; macOS is supported as a container host. Windows hosts and production workload orchestration are not supported. See the compatibility matrix and SECURITY.md.


aibox is a Rust CLI for developers who want a dependable terminal-first AI environment without rebuilding devcontainer, toolchain, and agent-runtime glue for every repository. Today, the maintained v0.x line turns a declarative aibox.toml into standard .devcontainer/ files, a project image, runtime UI configuration, selected AI harnesses, and pinned processkit context.

The useful outcome is a workspace another developer or agent can reproduce from a fresh clone with the same tools, entry points, and project context: aibox initaibox applyaibox up.

aibox dev layout

The recording shows the generated development container running the managed tmux layout, shell, editor, file browser, diagnostics, and configured AI harnesses from one project contract.

What works, what is changing

Area Current maintained v0.x Accepted v1 direction
Workspace image and local runtime Generates and runs Docker/Podman/OrbStack devcontainers Owns reproducible workspace images and deploys them to pre-existing Compose or Kubernetes targets
Processkit Downloads, installs, and updates pinned processkit content Delegates installation policy to the versioned processkit CLI protocol
Connection aibox up starts and attaches locally Deployment and aibox connect are separate, backend-neutral operations
Infrastructure Uses an existing container runtime Consumes existing targets; never provisions clusters, VMs, networks, identities, or cloud accounts

V1 is under active development in the independent v1.x line. The supported v0.x workflow remains available while its migration and rollback gates are proven. Follow the v1 architecture epic for implementation status; do not treat planned v1 behavior as current v0 behavior.

Why aibox

AI-assisted work fails quickly when the environment is half-local, half-memory, and only reproducible on one machine. aibox keeps the moving parts explicit:

  • One project contract: aibox.toml declares the base image, container identity, addons, AI harnesses, theme, layout, and processkit source/version.
  • Standard container output: generated .devcontainer/Dockerfile, docker-compose.yml, docker-compose.override.yml, and devcontainer.json remain understandable to Docker, Podman, OrbStack, and VS Code.
  • Composable tools: addons install language runtimes, AI CLIs, preview tools, infrastructure CLIs, and documentation frameworks only when selected.
  • Provider-neutral context: AGENTS.md is the canonical agent entry point; provider files such as CLAUDE.md are thin pointers.
  • Pinned process layer: processkit supplies skills, schemas, state machines, processes, and package definitions. aibox installs and updates that content.
  • Runtime visibility: aibox get runtime --resources and aibox doctor surface memory pressure, OOM signals, and process count risks before they turn into unexplained agent exits.

Install

Install a supported container runtime first:

  • Podman, including a Compose provider
  • Docker or Docker Desktop
  • OrbStack with Docker-compatible Compose

Then install the CLI:

curl -fsSL https://raw.githubusercontent.com/projectious-work/aibox/main/scripts/install.sh | bash
aibox --version

More options are covered in the installation guide.

Quick Start

mkdir my-project && cd my-project
git init

aibox init my-project --harness claude --addon python
aibox apply
aibox up

This creates:

  • aibox.toml as the source of truth
  • generated .devcontainer/ files
  • .aibox-home/ for persistent runtime config, ignored by git
  • context/ with processkit-managed project context
  • root-level AGENTS.md plus thin provider pointers
  • a tmux workspace mounted at /workspace

For an existing project, start with the existing-project guide.

Core Workflow

aibox apply                         # reconcile config, processkit content, files, and image
aibox apply --no-cache              # rebuild image without cached layers
aibox up                            # start or attach to the workspace
aibox up --layout focus             # override layout for one session
aibox get runtime --resources       # inspect memory/process pressure
aibox doctor                        # validate project and runtime posture

Older command names such as aibox sync, aibox start, and aibox status were replaced by the current verb/resource grammar. See the CLI reference for the mapping.

How It Fits Together

Layer Owned by What it contains
Project contract aibox aibox.toml, aibox.lock, .aibox-version
Container output aibox .devcontainer/, generated Compose, devcontainer JSON
Runtime home aibox .aibox-home/ tmux, shell, theme, and tool config
Addons aibox YAML definitions for installable tools and runtimes
Process content processkit skills, processes, schemas, state machines, AGENTS.md template
Project context shared editable context/ content plus immutable upstream snapshots

aibox intentionally does not own process semantics. If a behavior is about how agents plan, record decisions, or manage work items, it belongs in processkit. If it is about generating containers, selecting addons, wiring harness config, or launching the workspace, it belongs in aibox.

Within the Projectious ecosystem, aibox is the workspace image and deployment layer. Processkit owns agent-working practices and their installation policy; infrastructure templates may supply target references. Aibox is deliberately not a generic application platform or an infrastructure provisioner.

Documentation

Full documentation lives at projectious-work.github.io/aibox.

Section Contents
Getting Started Installation, new project, existing project
Container Base image, configuration, runtime operations, audio, file preview
Addons Overview, language runtimes, tool bundles, documentation frameworks
Providers Claude, OpenAI, Gemini, Copilot, Continue, Aider, Mistral
Context System Overview, skill selection, migration
Customization Themes, layouts, prompts
Reference Configuration, CLI commands, compatibility, cheatsheet
Contributing Maintenance, e2e tests, version-line porting

Development

This repository is developed inside its own devcontainer.

cd cli && cargo build
cd cli && cargo test
cd cli && cargo clippy --all-targets -- -D warnings
cd cli && cargo fmt -- --check

For full container lifecycle tests:

cd cli && cargo test --features e2e

Release quality expectations are strict:

  • zero Clippy warnings
  • all tests passing
  • cargo audit clean before tagging
  • releases created through ./scripts/maintain.sh release <version>

Repository Structure

Path Purpose
cli/ Rust CLI source for the aibox binary
addons/ YAML addon definitions for runtimes, tools, docs frameworks, and AI CLIs
images/ Base image recipes published for downstream projects
docs-site/ Docusaurus documentation site
context/ This repository's processkit-managed project context
scripts/ Release, install, and maintenance tooling
.devcontainer/ This repository's own development container

Contributing

Direct commits to main are the norm in this repository. Before contributing, read AGENTS.md, CONTRIBUTING.md, and the docs under docs-site/docs/contributing/.

Do not hardcode processkit vocabulary in production Rust code. Add constants to cli/src/processkit_vocab.rs instead.

All build, test, documentation, and release gates run locally. This repository does not use GitHub Actions; see the maintenance guide for the exact commands and release phases.

License

MIT. See LICENSE.

Unless otherwise noted, the copyright holder grants the MIT License for all versions of this repository, including historical commits and tags.

Brand and design system © projectious.work. The aibox mark is derived from that system.

About

aibox — Reproducible AI-ready devcontainers from one aibox.toml, with addons, provider-neutral agent context, and processkit integration.

Resources

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages