A3S Box
  • English

      • CLI reference

      The installed binary is the authoritative reference for its release:

      a3s-box --help
a3s-box <command> --help
a3s-box <command> <subcommand> --help

      Use --version and info when reporting a problem so command behavior can be matched to the runtime and host.

      Command groups

      AreaCommands
      Lifecyclerun, create, start, stop, restart, rm, kill, pause, unpause, wait, rename
      Executionexec, shell, attach, top
      Images and buildspull, push, build, images, rmi, tag, image-inspect, history, image-prune, save, load, import
      Filesystemscp, diff, export, commit, volume, snapshot
      Networkingnetwork, port, port-forward, compose
      Security and TEEattest, seal, unseal, inject-secret
      Observabilityps, logs, inspect, stats, events, df, audit, monitor
      Systemcontainer-update, system-prune, pool, login, logout, version, info

      Lifecycle model

      run is the create-and-start composition. Use create when configuration must be persisted before allocation, then start it explicitly.

      a3s-box create --name worker alpine:3.20 -- sleep 3600
a3s-box start worker
a3s-box inspect worker
a3s-box stop worker
a3s-box rm worker

      stop preserves the box. rm deletes a terminal box. kill is the convenient stop-and-remove operation in APIs that expose it as a lifecycle composition. Lifecycle state is generation-fenced so a stale caller cannot mutate a newer incarnation.

      Images

      a3s-box pull alpine:3.20
a3s-box images
a3s-box image-inspect alpine:3.20
a3s-box history alpine:3.20

      See Images and builds for build, registry, and archive workflows.

      Storage

      a3s-box volume --help
a3s-box snapshot --help
a3s-box cp --help
a3s-box diff --help

      Snapshots are created from stopped boxes. Named volumes have an independent lifetime and can be shared by multiple boxes when the workload semantics allow it.

      Networking and projects

      a3s-box network --help
a3s-box port-forward --help
a3s-box compose --help

      Network capability varies by host and isolation backend. Read the platform matrix before depending on bridge networking, published ports, or Compose.

      Structured automation

      Do not parse human tables in application code. Prefer command-specific JSON output where available or use a native SDK, which shares the runtime's typed state and machine protocol.

      Destructive maintenance

      Prune and removal commands are explicit operator actions. Inspect references and disk usage first:

      a3s-box ps -a
a3s-box images
a3s-box volume ls
a3s-box snapshot ls
a3s-box df

      Back up durable data before using force removal or broad system cleanup.