CLI Reference

athena

Usage:

athena [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--version	boolean	Show the version and exit.	False
--help	boolean	Show this message and exit.	False

clear

clear information about athena

Usage:

athena clear [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

cache

Empties the cache file

Usage:

athena clear cache [OPTIONS]

Options:

Name	Type	Description	Default
-p, --path	text	path to athena directory	None
--help	boolean	Show this message and exit.	False

environment

Clears the default environment

Usage:

athena clear environment [OPTIONS]

Options:

Name	Type	Description	Default
-p, --path	text	path to athena directory	None
--help	boolean	Show this message and exit.	False

history

Empties the history file

Usage:

athena clear history [OPTIONS]

Options:

Name	Type	Description	Default
-p, --path	text	path to athena directory	None
--help	boolean	Show this message and exit.	False

exec

Execute one or more modules without any additional processing of output.

PATH - Path to module(s) to run.

Usage:

athena exec [OPTIONS] [PATHS]...

Options:

Name	Type	Description	Default
-e, --environment	text	environment to run tests against	None
--help	boolean	Show this message and exit.	False

export

Export secrets or variables

Usage:

athena export [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

secrets

Export all secrets in the athena project

PATH - Path to athena project

Usage:

athena export secrets [OPTIONS] [PATH]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

variables

Export all variables in the athena project

PATH - Path to athena project

Usage:

athena export variables [OPTIONS] [PATH]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

get

get information about athena

Usage:

athena get [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

environment

Gets the default environment

Usage:

athena get environment [OPTIONS]

Options:

Name	Type	Description	Default
-p, --path	text	path to athena directory	None
--help	boolean	Show this message and exit.	False

history

Gets the default environment

Usage:

athena get history [OPTIONS]

Options:

Name	Type	Description	Default
-p, --path	text	path to athena directory	None
--help	boolean	Show this message and exit.	False

import

Import secrets or variables

Usage:

athena import [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

secrets

Import secrets for the athena project. Will prompt for confirmation. Data can also be supplied from stdin instead of a file.

PATH - Path to athena project

Usage:

athena import secrets [OPTIONS] [PATH]

Options:

Name	Type	Description	Default
-y, --yes	boolean	skip confirmation check	False
-f, --file	filename	secret data file to import, omit to read from STDIN	<_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>
--help	boolean	Show this message and exit.	False

variables

Import variables for the athena project. Will prompt for confirmation. Data can also be supplied from stdin instead of a file.

PATH - Path to athena project

Usage:

athena import variables [OPTIONS] [PATH]

Options:

Name	Type	Description	Default
-y, --yes	boolean	skip confirmation check	False
-f, --file	filename	variable data file to import, omit to read from STDIN	<_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>
--help	boolean	Show this message and exit.	False

init

Initializes an athena project at PATH/athena

Usage:

athena init [OPTIONS] [PATH]

Options:

Name	Type	Description	Default
-b, --bare	boolean	initialize project without example files	False
--help	boolean	Show this message and exit.	False

requests

Run one or more modules and print the request traces.

PATH - Path to file or directory of modules to watch.

Usage:

athena requests [OPTIONS] [PATHS]...

Options:

Name	Type	Description	Default
-v, --verbose	boolean	increase verbosity of output	False
-e, --environment	text	environment to run tests against	None
-p, --plain	boolean	format output as plain json	False
--help	boolean	Show this message and exit.	False

responses

Run one or more modules and print the response traces.

PATH - Path to file or directory of modules to watch.

Usage:

athena responses [OPTIONS] [PATHS]...

Options:

Name	Type	Description	Default
-v, --verbose	boolean	increase verbosity of output	False
-e, --environment	text	environment to run tests against	None
-p, --plain	boolean	format output as plain json	False
--help	boolean	Show this message and exit.	False

run

Run one or more modules and indicated whether they pass or fail.

PATH - Path to module(s) to run.

Usage:

athena run [OPTIONS] [PATHS]...

Options:

Name	Type	Description	Default
-v, --verbose	boolean	increase verbosity of output	False
-e, --environment	text	environment to run tests against	None
--help	boolean	Show this message and exit.	False

serve

Start serving one or more servers at the given paths.

PATH - Path to server module(s) to execute. Invalid module paths will be ignored.

Usage:

athena serve [OPTIONS] [PATHS]...

Options:

Name	Type	Description	Default
-v, --verbose	boolean	increase verbosity of output	False
--help	boolean	Show this message and exit.	False

set

set information about athena

Usage:

athena set [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

environment

Sets the default environment

Usage:

athena set environment [OPTIONS] ENVIRONMENT

Options:

Name	Type	Description	Default
-p, --path	text	path to athena directory	None
--help	boolean	Show this message and exit.	False

status

Print information about this athena project.

PATH - Path to file or directory of modules to watch.

Usage:

athena status [OPTIONS] [PATH]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

traces

Run one or more modules and print the full traces.

PATH - Path to file or directory of modules to watch.

Usage:

athena traces [OPTIONS] [PATHS]...

Options:

Name	Type	Description	Default
-v, --verbose	boolean	increase verbosity of output	False
-e, --environment	text	environment to run tests against	None
-p, --plain	boolean	format output as plain json	False
--help	boolean	Show this message and exit.	False

watch

Watch the given path for changes, and execute the given command on the changed file.

PATH - Path to file or directory of modules to watch.

Usage:

athena watch [OPTIONS] [PATH]

Options:

Name	Type	Description	Default
-v, --verbose	boolean	increase verbosity of output	False
-e, --environment	text	environment to use for execution	None
-c, --command	choice (requests | responses | traces | run | exec)	command to run on changed module	responses
-p, --plain	boolean	format output as plain json	False
-d, --debounce	float	duration (seconds) to wait before registering a file write. defaults to 0.1	0.1
--help	boolean	Show this message and exit.	False