Skip to content

OxFrancesco/codeview

Repository files navigation

codeview

A mostly headless CLI (built with Bun + OpenTUI) that keeps a registry of reference codebases and clones them into a project's resources/ folder so coding agents can read them for patterns, templates, and examples.

Install

Codeview requires Bun 1.2 or newer. Run it without installing:

bunx @oddofrancesco/codeview --help

Or install the command globally:

bun add --global @oddofrancesco/codeview

Usage

codeview add <git-url> [--name <name>] [--desc "what it does"]
codeview describe <name> "<description>"
codeview remove <name>
codeview list
codeview setup                 # interactive fuzzy picker
codeview setup <name...>       # headless: specific repos
codeview setup --all [--force] # headless: everything
codeview update                # refresh installed repos from their configured sources

setup stages repos before publishing them into ./resources/ (without .git), adds resources/ to .gitignore, and adds a section to both AGENTS.md and CLAUDE.md (creating them if missing) telling agents to read those folders. Codeview records the directories it owns in resources/.codeview-manifest.json; it refuses to replace an existing directory that is not in that manifest.

Repeated setup calls are incremental. Previously installed repos remain in the manifest and agent documentation, while the requested repos are replaced as one project transaction.

  • Registry: ~/.config/codeview/repos.json
  • Global cache: ~/.cache/codeview — repos fetched < 1 week ago are reused without network

Development

bun install
bun run test
bun run typecheck

Test discovery is restricted to the first-party test/ directory, so reference codebases under resources/ are never included.

License

Codeview is available under the Apache License 2.0.

About

Headless-first CLI to keep reference codebases at hand for coding agents (Bun + OpenTUI)

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages