See AGENTS.md for additional guidelines.
git clone https://github.com/dmae97/omk
cd omk
npm install
npm run buildRun from source:
/path/to/omk/omk-test.shThe script can be run from any directory. OMK keeps the caller's current working directory.
Configure via package.json:
{
"omkConfig": {
"name": "omk",
"configDir": ".omk"
}
}Change name, configDir, and bin field for your fork. Affects CLI banner, config paths, and environment variable names.
Three execution modes: npm install, standalone binary, tsx from source.
Always use src/config.ts for package assets:
import { getPackageDir, getThemeDir } from "./config.js";Never use __dirname directly for package assets.
/debug (hidden) writes to ~/.omk/agent/omk-debug.log:
- Rendered TUI lines with ANSI codes
- Last messages sent to the LLM
./test.sh # Run the non-LLM suite when a full run is intended
# Narrow, offline regression from the repository root:
LIVE_E2E=0 node node_modules/vitest/dist/cli.js --run packages/coding-agent/test/adaptorch-onboarding.test.tsThe root vitest.config.ts delegates to each package's Vitest project. This
preserves package-local setup files and source aliases; a root invocation must
not silently test stale dist dependencies. The coding-agent project resolves
omk-adaptorch-wpl to its source entrypoint during tests.
The coding-agent test setup shares a clock anchored to monotonic elapsed time
between Date.now(), new Date() and Date(), so host wall-clock resyncs cannot
invalidate integration receipts or consume deadlines. Explicit dates and injected
verification clocks remain unchanged; clock anomaly and stale-lock boundary tests
still exercise rejection. Simulated clock steps use fixed timestamps rather than
accumulating real host resyncs, and pruning fixtures use explicit ordered file
mtimes instead of comparing the process clock to the filesystem clock.
Package-local targeted commands continue to work, for example from
packages/coding-agent:
LIVE_E2E=0 node ../../node_modules/vitest/dist/cli.js --run test/adaptorch-onboarding.test.tsKeep explicit file filters for routine work. A keyless regression pass is not a live-provider or release verification, and unfiltered suites may include e2e tests.
The pre-commit hook validates the working tree without changing the selected index. It never auto-stages checker edits or unstaged hunks. If a checker changes the index, the hook fails and asks you to review the selection again; it does not restore or discard those changes. The checks still run against the working tree, not an isolated staged snapshot, so review partially staged changes separately.
Hook regression: node --test scripts/test/pre-commit-index.test.mjs.
packages/
ai/ # LLM provider abstraction
agent/ # Agent loop and message types
tui/ # Terminal UI components
coding-agent/ # CLI and interactive mode