Docs
Everything, in order
The written pages first, then the reference, which is read out of the source on every build and is exactly what the package publishes.
Start
Install it, write three files, run a job by hand, then give it a cron line.
Step, model, agentThree primitives, in the order to reach for them, and the test for which one you are writing.
A job is a workflowSteps, state, replay, and the one rule that makes carrying on after a pause safe.
Asking a personA job stops, sends its question to whoever should answer it, and carries on when they do.
A prompt with toolsThe loop, what a tool is, and what an agent may change about itself.
ChannelsPutting an agent on Telegram, and writing a way in that chloe does not ship.
ModelsA job picks its own model in one line, and a call goes out by key or by subscription.
Settings and credentialsTwo different things, kept apart, and four places where each one beats the last.
Testing and evalsCode is tested, words are scored, and reaching for the wrong one wastes an afternoon.
The page, and the run recordWhat a run writes down, where state lives, and the login in front of all of it.
One person, for nowWhat is baked in for a single person, and the four changes that are cheap now and expensive later.
The six entrancesWhat the package publishes, and why the list is short on purpose.
Reference
chloejsEverything an agent, a job, a tool or a channel is written with.
chloejs/toolsWhat a model can be handed. Each one is bound by an agent.
chloejs/timerWhen a job runs, written the way it is said.
chloejs/scorersHow a run is marked: what it did, and what it said.
chloejs/testSaying whether one thing came out right, for a job's own test file.
chloejs/channels/telegramAn agent on Telegram, bound in its own channels folder.
settingsEvery setting, its default and what it does, out of the schema the code reads.