8gent Code.Docs
Contributing

Contributing

How to build 8gent Code from source, run the checks, and get a change merged.

Source access

8gi-foundation/8gent-code is public. The licence is a draft pending legal review.

Build and run

git clone https://github.com/8gi-foundation/8gent-code.git
cd 8gent-code
bun install
bun run tui

8gent runs on Bun, not Node. Every script, test and the workspace itself run through Bun. Linux needs build tools and the Node 22 headers for native modules; see Install.

Check your change

bun test packages/ apps/     # unit tests (bun run test)
bun run lint                 # biome
bun run smoke:fast           # smoke test, no network
bun run tui                  # look at it

A change to the workspace is not done until you have looked at it in a real terminal, at a narrow width too, and with NO_COLOR=1.

Benchmarks

bun run benchmark:v2      # the benchmark harness
bun run benchmark:loop    # the computer-use failover bake-off

benchmark:v2 grades mostly by running the generated code against bun:test suites (70%), with a keyword check for the rest (30%). Results are in the repository's benchmarks/README.md.

Getting a change in

  1. Issue first. Find or open an issue in 8gi-foundation/8gent-code.
  2. Branch from main: feat/..., fix/..., docs/....
  3. Leave CHANGELOG.md alone. The release builds it from merged pull request titles, so write a clear title.
  4. Open a pull request with a summary, how you tested it, and Closes #<issue>.

House rules

  • No em dashes in copy. Use a hyphen or rewrite.
  • No purple, pink or violet (hues 270 to 350).
  • No secrets in code, logs or issues. Keys belong in ~/.8gent/keys.env.
  • State what exists, with evidence. No padded numbers.

Where to help

  • Local engines. llama-server and LM Studio on more machines and models.
  • Safety. Commands System One gets wrong, as test cases.
  • Accessibility. Screen readers, NO_COLOR, reduced motion, narrow terminals.
  • Docs. These pages live in 8gi-foundation/8gent-dev, under content/docs/.