Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.arkor.ai/llms.txt

Use this file to discover all available pages before exploring further.

arkor init

Drops Arkor’s starter files into your current directory: a Trainer under src/arkor/, an arkor.config.ts, and a dev / build / start script trio in your package.json. Use it from inside a directory you already own. For greenfield projects, use <pm> create arkor instead. See Quickstart.

Run it

pnpm arkor init
The command asks for a project name, picks a starter template, optionally runs git init, then installs dependencies. Take the defaults to get something working fast; come back later to customize.

Then what

Once init finishes, the next step is:
pnpm dev
Studio boots at http://127.0.0.1:4000. From there you can trigger a training run.

Reference

For all flags, error messages, package-manager detection rules, and the exact list of files written, see the arkor init reference.