Documentation

Welcome to the AKIOS documentation.

Getting Started

Quickstart →

Run your first sandboxed agent in 2 minutes.

Installation →

Install AKIOS via pip on native Unix, or use the container image.

Core Concepts

Sandbox: How we use seccomp-bpf and user namespaces.
Policies: Defining explicit access rules for agents.
Audit: How to verify agent actions.

Reference

Config Reference →

Learn which options you can configure in the AKIOS runtime.

Policy Schema →

See the YAML structure for network, filesystem, and limits.

Debugging →

Step through common failure modes and how to resolve them.

Best Practices →

Lean patterns for secure, performant workflows.

CLI Reference →

Essential commands for running and auditing AKIOS.

API Reference →

Use AKIOS programmatically via Python.

Deployment →

Minimal, security-first ways to ship the cage.

API Integration →

Secure HTTP/REST/GraphQL workflows.

Document Processing →

Ingest, redact, and analyze documents.

Migration →

Move to V1.0 pip/Docker safely.

FAQ & Glossary →

Key terms and quick answers.

Contributing

This documentation is community-maintained. To edit any page:

Find the .mdx file in site/docs/.
Edit the content.
Submit a PR!

Want to help? Open a PR on GitHub (/site/docs/*.mdx) or file an issue with the page name and suggested change. Small fixes (typos, broken links, clearer steps) are welcome.