Skip to main content

a13n Environment

a13n-environment is the shared Host-facing Environment provider library for Agent Foundation. The repository directory is packages/a13n-environment, the Python distribution is a13n-environment, and the import package is a13n_environment.

The package owns:

  • credential-free EnvironmentProviderSpec envelopes and exact versioned configuration validation;
  • metadata-only installed Provider discovery and immutable built-in, extension, and explicit-object catalogs;
  • inert EnvironmentProvider plugins that construct fresh adapters;
  • single-use Environment adapters with creation or re-entry, readiness, provider-neutral operations, cached state, non-destructive close, and explicit destruction;
  • portable provider-owned EnvironmentState soft references;
  • typed Provider errors with bounded safe projections;
  • Native Direct Local/Docker/E2B and Envd Local/HTTP/WebSocket built-ins;
  • EIP session sources and reusable stdio-carrier values shared with managed sandbox Providers.

Embedding code resolves a trusted Provider, validates configuration, supplies current state and fresh runtime collaborators, and constructs one new adapter per independent Harness Run:

configuration = provider.validate_configuration(
    schema_version=spec.schema_version,
    value=spec.configuration,
)
environment = provider.create_environment(
    configuration=configuration,
    environment_id="workspace",
    state=current_state,
    runtime=fresh_runtime,
)

try:
    result = await executable.run("Use the workspace", environment=environment)
finally:
    current_state = environment.dump_state()

Provider validation and adapter construction perform no external I/O. Harness enters and closes the adapter exactly once. close() releases process-local resources without deleting the target; Harness never calls destroy(). When Host retention policy selects removal, the Host constructs a separate fresh adapter from the exact current state and calls destroy() explicitly.

The package does not own durable storage, Host authorization or scheduling, Harness Runs, model-facing tools, mount names, access ceilings, or target retention policy. The Host persists authoritative EnvironmentState; Harness owns only Run-local aggregate routing and state mapping.

Direct Local exposes an existing Host directory and never deletes, tags, locks, or claims ownership of it. Local Envd launches one compatible Host-selected a13n-envd generation for each fresh adapter and removes only its private runtime on close. Docker creates or re-enters a native container, uses Engine exec for operations, and preserves the container and background commands on close. Explicit destruction removes its private filesystem and preserves external host mounts. E2B implements native SDK operations with bounded command-local byte capture, state re-entry, pause/resume, keepalive and explicit destruction; it requires no envd installation or custom template. The catalog contains no placeholder or fallback selection.

Choose a Provider

Route Provider Use it for Operation and ownership boundary
Native direct-local Trusted local automation Host OS operations; existing directory, no sandbox claim
Native e2b Native managed cloud sandbox E2B SDK; sandbox create/pause/resume/renew/destroy
Envd a13n.local-envd CLI and local Agents Private stdio daemon; close preserves workspace
Native docker Small single-node self-hosted services Docker lifecycle and native exec; close preserves container
Envd a13n.http-envd Network-reachable external environments HTTP(S) EIP; connect-only
Envd a13n.websocket-envd Environments that connect back to a Host Reverse WebSocket EIP; Host-integrated SDK, connect-only

See Remote Envd for one-command local demos, external HTTP connection and Host-owned reverse WebSocket integration. The SDK starts no listener; close preserves the external daemon and workspace.

Docker development

The default configuration selects the Envd-free ghcr.io/converge-ai-labs/a13n-docker-environment:dev image. Each Environment has its own /workspace. Templates can add existing host-directory mounts; named volumes and bootstrap storage are not template options.

The Host supplies a Docker client through the runtime and owns its closure:

import asyncio
from a13n_environment import DockerProviderRuntime, DockerSDKEngine

engine = await asyncio.to_thread(DockerSDKEngine.connect, "unix:///var/run/docker.sock")
runtime = DockerProviderRuntime(engine=engine)

Run unit tests with make docker-provider-test. Build the native image with make image-docker-environment, then run real lifecycle and operation checks:

make docker-provider-live-test

Single-host Compose uses the host Docker Engine through its Unix socket. Configure external bind paths in that Engine's filesystem namespace.

Local Envd development

Hosts select the daemon executable once when constructing LocalEnvdProviderRuntime. The convenience resolver uses this precedence:

  1. an explicit path passed to resolve_a13n_envd_executable();
  2. A13N_ENVD_EXECUTABLE;
  3. a13n-envd (or a13n-envd.exe) discovered through PATH with shutil.which().

The resolver expands path values, resolves them against the caller's current directory, validates one executable regular file, and returns an absolute path. The package never reads .env, changes PATH, installs a daemon, or rediscovers the executable after runtime construction.

from a13n_environment import (
    LocalEnvdProviderRuntime,
    TemporaryLocalEnvdRuntimeAllocator,
    resolve_a13n_envd_executable,
)

runtime = LocalEnvdProviderRuntime(
    executable=resolve_a13n_envd_executable(),
    allocate_private_runtime=TemporaryLocalEnvdRuntimeAllocator(),
)

Repository developers can optionally copy the A13N_ENVD_EXECUTABLE entry from .env.harness.example into the root .env. The focused target builds the source-tree daemon, loads .env only inside the target shell, defaults the variable to target/debug/a13n-envd, and runs the real Local Envd tests:

make local-envd-test

See the Environment guide for Harness usage, state re-entry, explicit destruction, and third-party plugin development. The runnable built-in Provider example exercises Direct Local, Local Envd, and Docker from Host code.

Versioning

a13n-environment, a13n-harness, and a13n-stream-protocol form the Harness release group. A release/a13n-harness-v<version> tag publishes all three distributions at exactly the same version, where <version> is stable X.Y.Z or RC X.Y.Z-rc.N. Python package metadata represents the RC as X.Y.ZrcN.

The accepted architecture and compatibility contract are defined in the a13n Environment specification.

Metadata

Release files for a13n-environment 0.0.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for a13n-environment 0.0.26
File Size Uploaded
a13n_environment-0.0.26.tar.gz 158.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for a13n-environment 0.0.26
File Interpreter ABI Platform
a13n_environment-0.0.26-py3-none-any.whl Python 3 none any Details

Total release size: 310.8 kB

Release files / a13n_environment-0.0.26.tar.gz

Download URL a13n_environment-0.0.26.tar.gz
Size 158.1 kB
Tags Source
SHA-256 checksum
How to use checksums
10a932fde038915adc7d6476ba95aff69e76603fdb79c11599a11f37f45a312f
BLAKE2b-256 checksum
How to use checksums
49348a9adc61d1a0da4d18b50d20050119ab876d9f4abf24f4a467c748d35bfb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / a13n_environment-0.0.26-py3-none-any.whl

Download URL a13n_environment-0.0.26-py3-none-any.whl
Size 152.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a249809c7d0322ce5ee23e9adf3d8602bdc868886282dee9d3f2568e2c7225dc
BLAKE2b-256 checksum
How to use checksums
e7ace09e1ef78fc8b60466cd090842b76bd842d92a2dae71424468cf490139e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.15 {"installer":{"name":"uv","version":"0.12.15","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.0.31

2 release files

0.0.29

2 release files

0.0.28

2 release files

This release

0.0.26 This release

2 release files

0.0.25

2 release files

0.0.24

2 release files

0.0.23

2 release files

0.0.22

2 release files

0.0.21

2 release files

0.0.18

2 release files

0.0.17

2 release files

0.0.16

2 release files

0.0.15

2 release files

0.0.14

2 release files

0.0.13

2 release files

0.0.12

2 release files

0.0.10

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page