DocsGetting Started
Installation
How to install the Athena CLI globally or run it ephemerally with npx.
$npm install -g project-athena
Prerequisites
- Node.js: Requires Node.js ≥ 22.12.0. Check your version with
node -v. - Operating System: macOS, Linux, or Windows.
- Git (optional): if present, Athena records the branch and commit and uses Git history to detect changes. Without Git, those details are reported as unknown.
Global Installation via npm
Install the Athena CLI globally using npm:
bash
npm install -g project-athenaVerify your installation:
bash
athena --versionEphemeral Execution via npx
If you prefer not to install globally, execute Athena directly in your project root:
bash
npx project-athena init