awaken

$installer = Join-Path $env:TEMP 'install-awaken.ps1'
Invoke-WebRequest https://github.com/awakenworks/awaken/releases/download/v1.0.0/install.ps1 -OutFile $installer
powershell.exe -NoProfile -ExecutionPolicy Bypass -File $installer v1.0.0
awaken --version

For provenance-sensitive Windows installations, verify install.ps1 against install.ps1.sha256 before running it. The full platform mapping is:

Each archive has a sibling .sha256 file. Verify it before extracting the archive. GitHub also publishes a build-provenance attestation for every release asset; with the GitHub CLI installed, verify it with gh attestation verify <archive> --repo awakenworks/awaken.

To build from source, install Rust 1.96.0, Node.js, and pnpm 11.6.0, then run:

pnpm install --frozen-lockfile
cargo build --locked --release -p awaken-cli --bin awaken
./target/release/awaken --version

Try Awaken

Start the installed program:

awaken

Running awaken without a command is the same as awaken all-in-one: it starts the API, embedded web console, and local worker, persists all local state under ~/.awaken, and opens http://127.0.0.1:8080. Use --port, --data-dir, or --no-browser for common local overrides. The resulting binary contains the complete console and needs no external web directory or Node.js at runtime.

The default execution adapter follows the host's implemented capability: Linux uses bubblewrap Namespace isolation, macOS uses Seatbelt Namespace isolation, and Windows uses the host-backed Local adapter because Awaken has no Windows Namespace adapter. Linux therefore requires a usable bwrap; run awaken doctor for an actionable readiness result. Windows Local execution and an explicitly configured Local tier have no OS isolation and are appropriate only for trusted, single-user workstations.

To deliberately use programs already installed on the host on any platform, set the one deployment authority in ~/.awaken/config.toml (on Windows, %USERPROFILE%\.awaken\config.toml):

sandbox_tier = "local"

A Worker whose primary tier remains Namespace/Container can additionally opt in to exact host execution with sandbox_trusted_host_enabled = true. In both cases the Environment must bind a trusted_host + workdir execution policy; the setting only advertises Worker capability and never silently changes an isolated Environment.

The Local adapter launches ACP CLIs and shell commands as host child processes with the Session workspace as their working directory. Files, repositories, MemoryStores, Skills, and outputs still enter through Agent resource bindings; prompts receive only provider-relative paths and no second resource authority is created. The child is nevertheless unconfined and can access anything the host user can access, so TrustedHost is never a cloud or multi-tenant boundary. Use an MCP server when an existing local service should be called through a narrower capability instead of ambient filesystem access.

The Console guides one canonical path:

1. Connect a model provider or sign in to a detected ACP runtime.
2. Choose a starter and define one real task.
3. Review and publish the immutable Agent revision.
4. Follow the durable Session and its committed events.

Run the same product from the signed container image when a local binary is not convenient:

docker compose -f deploy/compose.yaml up -d
docker compose -f deploy/compose.yaml logs awaken

Open http://127.0.0.1:8080 and use the one-time setup token printed in the logs. The named volume preserves local state across container replacement. This Compose preset is for single-user evaluation: the Management container is the outer isolation boundary and its embedded Worker uses the local sandbox tier. Use the operator configuration below for shared or multi-tenant systems.

Before startup, diagnose the selected configuration, data directory, and listener without creating product state. ACP discovery remains available under the same diagnostic command:

awaken doctor
awaken doctor --json
awaken doctor acp

Build with Awaken

After the first Session is running, open API & protocols in the Console for copyable Managed Agents, Vercel AI SDK, AG-UI, A2A, and MCP examples. Every protocol uses the same published Agent and durable Session authority.

Runtime-internal examples under crates/sdk/devtools/awaken-runtime-examples/ teach embedding and extension mechanics; they are not a second product quickstart.

Operate Awaken

All-in-one, split Control/Coordinator/Worker topology, typed configuration, database migration, secret projection, and private service boundaries are owned by deploy/README.md. The k3d material is a distributed verification topology, not the local onboarding path.

For implementation boundaries, runtime coverage, architecture invariants, and documentation checks, continue to docs/README.md. To build, test and commit changes, start with CONTRIBUTING.md.

License

Apache License, Version 2.0. See LICENSE.