Run from source & CLI

Development requirements#

The project declares Node 20.19+, 22.12+, or 23+ for the CLI. Use Node 22.12+ for desktop development and packaging. Check the repository’s package.json for the current requirements. Commands below run from the repository root.

Get the source#

git clone --branch ankita https://github.com/akyourowngames/A.N.K.I.T.A.git
cd A.N.K.I.T.A
npm ci

Start the desktop#

For the production renderer, run npm run desktop:build followed by npm run desktop:start.

npm run desktop:dev

Use the terminal#

Copy .env.example to .env and configure the CLI provider. On PowerShell use Copy-Item .env.example .env; on POSIX use cp .env.example .env. A global config.env is also supported under the config directory; CONFIG_DIR can override it. Desktop settings take priority for desktop sessions.

npm link
ankita
ankita -p "Summarize this repository"
ankita --continue
ankita --list-models

Find commands#

Use /help for the current command list. /model selects a model; /tools shows tools; /skills shows skills; /project selects a project; /save and /load manage sessions. /bg, /jobs, /job, /input and /stop manage command jobs.

ankita --daemon runs background schedules, watches, notifications and Telegram. Optional voice features need their additional audio dependencies; ordinary chat and desktop setup do not.