Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview
On this page

athena ad commands

The athena command-line tree for attack/defence events.

Most attack/defence operations in the event dashboard are also athena ad commands; the ones that aren’t are listed below. Install the CLI and point it at your event as described in Use the athena CLI; the global options (--event, --url, --key, --json, --yes) work the same way. The jeopardy commands in CLI commands don’t apply to an attack/defence event.

Run athena ad <command> --help for each command’s arguments.

Game

Command What it does
athena ad stats Event totals: teams, services, ticks, submissions, captures.
athena ad game get The game phase, last completed tick and pause reason.
athena ad game pause Pause the game with a reason shown to players.
athena ad game resume Resume a paused game.
athena ad game open Request the network open.
athena ad game opening The current host’s opening steps: each box’s snapshot, the egress seal, and why one failed.
athena ad game retry-opening Retry a failed opening; steps that already succeeded aren’t repeated.
athena ad game end-status Whether the event’s end has been recorded and completed.
athena ad roster get The admitted roster and the admission cap.
athena ad roster lock Lock the roster now.
athena ad config Read and update event settings.

Services

Command What it does
athena ad service list / get List services, or show one with its stores.
athena ad service create Register a service from a JSON spec.
athena ad service update Change a service’s name, description, ports, timeout or position.
athena ad service image Record new image digests.
athena ad service enable / disable Put a service in or out of play.
athena ad service store Relabel a flag store.
athena ad service source-set / source-clear Attach or detach the source archive.
athena ad service delete Delete a service.

Teams and players

Command What it does
athena ad team list / get List teams, or show one with scores, members, keys and box.
athena ad team rename Rename a team.
athena ad team delete Delete an empty team that hasn’t been admitted.
athena ad team member-add / member-remove Move a player onto or off a team.
athena ad team create-reference Create a reference team before the roster locks.
athena ad team visibility Make a team a reference team or a scored one, before the roster locks.
athena ad team token Show a team’s newest submission token and its hash.
athena ad team tokens List every live generation of a team’s submission token, with hashes.
athena ad team token-issue Issue a new token generation; earlier ones stay live until revoked.
athena ad team token-revoke Revoke one token generation by its hash.
athena ad team ssh-key-revoke Revoke one of a team’s SSH keys.
athena ad player List, inspect, ban, unban and delete players.
athena ad player vpn-revoke Revoke a player’s VPN peer.

Host, boxes and checks

Command What it does
athena ad host get The event host’s state.
athena ad host incident Report a host compromise.
athena ad host history Earlier hosts this event had, and any compromise reported against them.
athena ad notifications Player emails and their delivery outcome.
athena ad box list / get Every team’s box, or one with its SSH keys.
athena ad box restore Restore a team’s box from its snapshot.
athena ad runner get The checker runner’s state.
athena ad runner restart Request a runner restart.
athena ad check list Scored checker attempts.
athena ad check run Run a diagnostic service check against one team.
athena ad check diagnostics / bundle List diagnostics, or print one’s output.
athena ad integrity filtering Filtering findings with their evidence, filterable by verdict.

Dashboard-only operations

These have no athena ad command:

  • The event host’s lifecycle: getting a sizing quote, reserving the host, cancelling an allocation, releasing a reservation and replacing the host, all on Event host. athena ad host replace explains the replacement steps rather than performing them.
  • Rotating the platform’s access key under Provisioner access on Event host.
  • Game settings and the schedule. athena ad config reads them, but a change to the tick, flag validity, checker timeout, scoring weights, roster deadline or event dates is refused unless it comes from the dashboard, which keeps the event and your account in step.
  • Ending the event early, from Settings → Danger zone.

Everything else

athena ad scoreboard, submission, analytics, announcement, storage, files, report, key, certificate, discord, audit and feedback work as their jeopardy counterparts do, against the attack/defence event.

One difference in athena ad storage: each file id takes exactly one upload. An upload can’t replace a stored file, and a deleted file’s id can’t be used again, so upload a changed file under a new id (the default when you leave out --file-id). A file id is 1 to 128 letters, digits, hyphens, underscores or dots; it can’t start with a dot or contain two dots in a row, and any other id is refused before upload. Storage holds service source archives (up to 512 MiB each) and certificate backgrounds (up to 4 MiB each).

Was this page helpful?