aone

aone

aone is the AoneSuite command-line tool and SDK monorepo. The root module builds the CLI for managing sandboxes, templates, and account credentials against the Aone API. packages/go contains the Go SDK packages for sandbox automation and text-to-speech.

Install

The CLI currently builds with Go 1.26.2 or newer.

go install github.com/aonesuite/aone@latest

Or build from source:

git clone https://github.com/aonesuite/aone
cd aone
go build -o aone .

Local development uses Go workspaces:

go test ./...
cd packages/go && go test ./...

See docs/development.md for the full development workflow.

Quick start

# 1. Save credentials (writes ~/.config/aone/config.json with mode 0600)
aone auth login --api-key ak_xxx

# 2. Verify the active credential source
aone auth info

# 3. Scaffold a template project
aone sandbox template init --name my-app --language go --path ./my-app

# 4. Build the template (template_id is written back to aone.sandbox.toml)
cd my-app
aone sandbox template create my-app

# 5. Launch a sandbox from the project's template
aone sandbox create

Authentication

Credentials are resolved with the following precedence:

env AONE_API_KEY   >  ~/.config/aone/config.json
env AONE_API_URL   >  config file  >  built-in default

auth login --api-key/--endpoint and auth configure --api-key/--endpoint write values to the config file. Regular sandbox and TTS commands do not expose temporary --api-key or --endpoint flags; use environment variables for per-command overrides.

AONE_CONFIG_HOME overrides the config directory, useful for tests so they don't pollute the real ~/.config/aone.

See docs/authentication-and-debugging.md for credential management and debug logging details.

Project configuration: aone.sandbox.toml

Template-related commands accept -p/--path (project root) and --config (explicit file). When neither is given, the file in the current directory is used. Fields:

template_id   = "tpl_xxx"   # written automatically after build
template_name = "my-app"
dockerfile    = "Dockerfile"
start_cmd     = ""
ready_cmd     = ""
cpu_count     = 0
memory_mb     = 0
disk_size_mb  = 0
public        = false

Commands that consume the file: template build, template create, template delete, template publish / unpublish, sandbox create.

See docs/sandbox-templates.md for the full template project workflow.

Command reference

Top-level groups (run aone <cmd> --help for full flag listings):

aone auth        login | logout | info | configure
aone sandbox     list | create | connect | info | kill | exec | logs |
                 metrics
aone sandbox template   init | create | list | get | delete | publish |
                        unpublish | builds | logs | migrate
aone tts         voices | speech

See docs/cli-reference.md for a compact command and flag reference.

Common flags:

• -v / -vv — debug / trace logs to stderr (network calls, config resolution, redacted headers + bodies). Stdout stays clean so pipelines like aone sandbox list -f json | jq keep working.
• --debug — alias of -v; also sets AONE_DEBUG=1 so SDK-level debug paths fire.
• --version — print the CLI version.
• --format pretty|json — supported by sandbox list / info / logs / metrics and template list / logs commands.

Common aliases:

• aone sandbox can be shortened to aone sbx.
• aone sandbox template can be shortened to aone sandbox tpl.
• aone tts voices lists available text-to-speech voices; aone tts speech synthesizes text and prints the generated audio URL.
• Frequently used subcommands also have short aliases, for example list / ls, create / cr, connect / cn, exec / ex, and logs / lg.

See docs/tts.md for text-to-speech CLI and SDK examples.

aone sandbox template create <template-name> is the primary template build surface. The lower-level template build command still exists internally but is hidden from normal help output.

aone sandbox create can run detached with --detach, pass environment variables with --env-var KEY=VALUE, attach metadata with --metadata, and set network policy options such as --allow-out, --deny-out, and --allow-internet-access.

aone sandbox template create <template-name> builds from aone.Dockerfile or Dockerfile by default. Use --dockerfile, --path, --cmd, --ready-cmd, --cpu-count, --memory-mb, and --disk-size-mb to override the build context and runtime defaults.

aone sandbox template migrate converts an existing Dockerfile into SDK-native template code for Go, TypeScript, or Python.

Go SDK

The Go SDK lives in the nested module:

github.com/aonesuite/aone/packages/go

Current public packages:

Sandbox example:

import "github.com/aonesuite/aone/packages/go/sandbox"

client, err := sandbox.NewClient(&sandbox.Config{
	APIKey: os.Getenv("AONE_API_KEY"),
})
if err != nil {
	return err
}

sb, _, err := client.CreateAndWait(ctx, sandbox.CreateParams{
	TemplateID: "base",
}, sandbox.WithPollInterval(2*time.Second))
if err != nil {
	return err
}
defer sb.Kill(ctx)

TTS example:

import "github.com/aonesuite/aone/packages/go/tts"

client, err := tts.NewClient(&tts.Config{
	APIKey: os.Getenv("AONE_API_KEY"),
})
if err != nil {
	return err
}

voices, err := client.ListVoices(ctx)
if err != nil {
	return err
}
if len(voices) == 0 {
	return fmt.Errorf("no TTS voices available")
}

audio, err := client.Synthesize(ctx, tts.SynthesizeParams{
	Text:  "Hello from Aone.",
	Voice: voices[0].ID,
})
if err != nil {
	return err
}
fmt.Println(audio.AudioURL)

Both SDK packages read AONE_API_KEY when Config.APIKey is empty and AONE_API_URL when Config.Endpoint is empty. The default endpoint is https://api.aonesuite.com.

Debug mode

When something goes wrong, re-run the command with -v (debug) or -vv (trace). Output goes to stderr so pipelines aren't affected.

aone -v  sandbox list                # HTTP method/url/status/duration, config source
aone -vv sandbox list                # + redacted request/response headers and bodies

Triggers (any one works; higher precedence wins):

Other knobs:

• AONE_LOG_FORMAT=json — emit JSON records instead of human-readable text.
• AONE_LOG_FILE=/tmp/aone.log — write logs to this file (mode 0600) instead of stderr.

API keys, Authorization, cookies, and JSON fields like apiKey / password / token are masked before logging.

Environment variables

Repository layout

This repository is organized as a CLI plus multi-language SDK monorepo:

See docs/cli-reference.md for command reference, docs/authentication-and-debugging.md for auth and debug logging, docs/sandbox-templates.md for template workflows, docs/tts.md for text-to-speech usage, docs/development.md for contributor setup, CHANGELOG.md for current user-visible changes, and docs/release.md for the Go SDK and CLI versioning rules.