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

CLI commands

Every athena command, grouped by area, with its aliases and what it does.

Every command in the athena CLI, grouped the way athena --help groups them. For installing the tool and pointing it at an event, see Use the athena CLI.

Run athena <group> --help for a group’s arguments, or athena <group> <command> --help for one command’s flags.

Global flags

These work on every command.

Flag What it does
--url <URL> Admin API URL, with or without /api/admin on the end. Overrides --event, the environment, and the current event.
--key <KEY> Admin API key. Same precedence as --url.
-e, --event <NAME> Target a saved event by name.
--json Print the raw JSON response instead of a formatted summary.
-y, --yes Skip confirmation prompts on destructive commands.
-v, --version Show the version number.
-h, --help Print help for whatever you’re running.

event

Manages the events saved on your machine. These commands touch no API.

Command Aliases What it does
event add <name> --url --key [--use] Add or update a named event
event use <name> Set the current event
event list ls List configured events
event rm <name> remove Remove a named event

config

Reads and updates the versioned event settings.

Command Aliases What it does
config get show Show the current event settings
config versions List the settings version history
config set update Update settings (reads current, applies your edits, patches)
config revert Make a previous version current again

The event’s start, freeze and end times can’t be changed here; they move automatic teardown with them and belong on the Settings page.

key

Alias for the group: keys.

Command Aliases What it does
key list ls List the event’s admin API keys

Creating and revoking keys stays in the dashboard.

stats

Command What it does
stats Show event totals: users, challenges, submissions, solve rate

challenge

Aliases for the group: challenges, chal.

Command Aliases What it does
challenge list ls List challenges
challenge get <id> Show a challenge with its hints, files and prerequisites
challenge by-category Count challenges per category
challenge create Create a challenge from a JSON payload and/or flags
challenge update <id> Patch a challenge’s own fields (only the flags you pass are sent)
challenge apply <id> --file Reconcile against a desired-state JSON file, issuing only the calls that differ
challenge show <id> Put a hidden challenge on the board, now or at --release-at
challenge unschedule <id> Return a scheduled challenge to hidden (refused once it has been live)
challenge lock <id> --reason Lock a live challenge and kill its running instances
challenge unlock <id> Return a locked challenge to play
challenge delete <id> rm Delete a challenge and reverse every point it moved

Hints, files, the flag and prerequisites are edited one row at a time, not through update:

Command Aliases What it does
challenge hint add Add a hint to a challenge
challenge hint set Replace a hint’s content and penalty, keeping every team’s unlock
challenge hint rm remove, delete Delete a hint, refunding what every team paid to unlock it
challenge file add Attach an already-uploaded object (upload it first with storage upload)
challenge file rm remove, delete Detach a file and delete the stored object
challenge flag set Replace the answer key, clearing per-team dynamic flags when you switch to static
challenge prereq add Gate a challenge behind another one
challenge prereq rm remove, delete Remove a prerequisite gate

The prereq group also answers to prereqs and prerequisites; hint to hints; file to files.

draft

Alias for the group: drafts.

Command Aliases What it does
draft list ls List challenge drafts
draft get <id> show Show a challenge draft
draft create new Create a draft, empty or from form data
draft set <id> save Replace a draft’s form data
draft publish <id> Publish a draft as a challenge and delete the draft
draft delete <id> rm Delete a draft and its orphaned uploads

category and difficulty

Group aliases: categories, difficulties.

Command Aliases What it does
category list / difficulty list ls List the taxonomy
category create / difficulty create add Create one
category update / difficulty update rename (category only) Update one
category delete / difficulty delete rm Delete one, only when no challenge uses it

player

Alias for the group: players.

Command Aliases What it does
player list ls List players, 50 at a time; page with --limit and --offset, filter with --search, order with --sort and --desc
player get <id> show Show a profile, stats and solves
player activity <id> Show a player’s activity timeline
player ban <id> Ban a player and revoke their sessions
player unban <id> Lift a ban
player discord get <id> show Show a player’s Discord link
player discord unlink <id> Detach a player’s Discord account and remove them from the event server
player delete <id> rm Delete a player, detach them from their team, and reverse the points they contributed

team

Alias for the group: teams.

Command Aliases What it does
team list ls List teams by score, 50 at a time; page with --limit and --offset, filter with --search, order with --sort and --asc
team get <id> show Show a profile, stats, members and solves
team rename <id> Rename a team, 2–32 characters, explicit teams only
team member list ls List the members of a team (the member group also answers to members)
team member add Move a player onto a team
team member remove Remove a player from a team
team delete <id> rm Delete an empty team

score and leaderboard

Command Aliases What it does
score adjust Apply a manual score adjustment to a team
leaderboard list ls Show the current leaderboard
leaderboard progression Show score progression for the top teams
leaderboard rebuild Recompute the standings from the event’s recorded results

announcement

Group aliases: announcements, ann.

Command Aliases What it does
announcement list ls List announcements, pinned first
announcement create add Publish an announcement
announcement update <id> Edit an announcement
announcement delete <id> rm Delete an announcement

report

Alias for the group: reports.

Command Aliases What it does
report list ls List challenge and platform reports
report get <id> show Show a report and its message thread
report reply <id> message Append an organizer message to an open report
report close <id> Close a report

discord

Command Aliases What it does
discord get show Show whether the integration is on, plus the staff and verified role ids
discord enable Turn the Discord integration on
discord disable Turn the Discord integration off
discord set-staff-role <role-id> Set the Discord role allowed to run the bot’s staff commands
discord set-staff-role --clear Clear the staff role, which disables every staff command

submission and analytics

Command Aliases What it does
submission list ls List flag submissions, newest first
submission over-time Show submission counts per day
analytics overview Show the analytics overview
analytics submissions Show submission analytics
analytics challenges Show per-challenge analytics
analytics export Export the analytics report as JSON

The submission group also answers to submissions.

instances

Alias for the group: challenge-instances.

Command Aliases What it does
instances list ls List challenge instances
instances reap Terminate running challenge instances
instances drift List instances that may not have shut down

anticheat

Alias for the group: integrity.

Command Aliases What it does
anticheat findings list, ls List findings
anticheat get <id> Show one finding with its evidence
anticheat review <id> Move a finding to another review state
anticheat status Show the last run and per-detection coverage
anticheat internal list ls List the internal and test subjects findings skip
anticheat internal add Stop raising findings for a team handle or username
anticheat internal remove Raise findings for this subject again

The internal group also answers to exclusions.

certificate

Command Aliases What it does
certificate list ls List issued certificates
certificate issue Issue certificates from the live leaderboard and saved tiers, and have Athena sign them; succeeds only once every new certificate is signed
certificate revoke <id> Revoke an issued certificate
certificate mark-emailed Record that certificates have been emailed
certificate template list ls List templates for this event
certificate template create Create a template
certificate template get <id> Print a template’s draft layout, or a published one with --version
certificate template set <id> Replace a template’s draft layout from a spec JSON file
certificate template publish <id> Publish a draft as an immutable version
certificate template delete <id> Delete a template and its versions
certificate tiers get Show the award tiers in priority order
certificate tiers set Replace the tier list from a JSON file

The template group also answers to templates.

certificate issue sends your event’s site URL and key to the Athena dashboard at https://app.athena-ctf.com, which checks that the key belongs to that event, issues the certificates under the event name on your Athena account and signs them. Set ATHENA_PANEL_URL, or panelUrl in the config file, only if your Athena dashboard lives elsewhere. If some certificates are left unsigned, the command says how many and exits with an error. Run it again: it signs the remaining ones without issuing new credential IDs.

files, storage and image

Command Aliases What it does
files List uploaded challenge files and their download counts
storage usage Show storage usage against your event’s limit
storage upload-url Mint a signed upload URL
storage upload <path> Mint a signed URL and upload a local file through it
storage delete <id> rm Delete a stored file (refused while anything still uses it). --prefix takes challenge_files (default), certificates, avatars or writeups
image list ls List image builds
image usable List image builds that challenges can reference
image usage Show image build storage and build-minute usage
image create Register an image build and mint its build-context upload URL
image start <id> Start building a registered image
image cancel <id> Cancel a queued or running build
image delete <id> rm Delete an image build

The image group also answers to images and image-builds.

audit, feedback and writeup

Command Aliases What it does
audit Read the event’s audit log; filter with --action, --actor, --subject, --limit, --offset
feedback Show player feedback ratings and comments
writeup list ls List submitted writeups
writeup download <id> get Download a writeup through a signed URL

The writeup group also answers to writeups.

Was this page helpful?