Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
codr
command
Command codr is the single binary of the Codr git forge.
|
Command codr is the single binary of the Codr git forge. |
|
codr-runner
command
Command codr-runner is the CI runner of Codr (D89): a separate binary that receives push webhooks, runs the jobs of .codr/ci.toml in locked-down containers and reports them as commit statuses.
|
Command codr-runner is the CI runner of Codr (D89): a separate binary that receives push webhooks, runs the jobs of .codr/ci.toml in locked-down containers and reports them as commit statuses. |
|
Package docs carries the design write-up (D90) so the landing page can serve it: docs/design.md (English) and docs/reka-bentuk.md (Malay).
|
Package docs carries the design write-up (D90) so the landing page can serve it: docs/design.md (English) and docs/reka-bentuk.md (Malay). |
|
internal
|
|
|
ai
Package ai calls a chat-completions endpoint that speaks the OpenAI wire format (OpenAI, a gateway such as 9router or LiteLLM, Ollama, vLLM, …) — the endpoint, model and key are the owner's choice (D71).
|
Package ai calls a chat-completions endpoint that speaks the OpenAI wire format (OpenAI, a gateway such as 9router or LiteLLM, Ollama, vLLM, …) — the endpoint, model and key are the owner's choice (D71). |
|
auth
Package auth hashes and verifies web passwords with argon2id (D8: passwords are for the web only; git over SSH uses keys and git over HTTPS uses tokens).
|
Package auth hashes and verifies web passwords with argon2id (D8: passwords are for the web only; git over SSH uses keys and git over HTTPS uses tokens). |
|
backup
Package backup writes a consistent snapshot of an install (D41, D54): the DB via VACUUM INTO (WAL-safe), config.toml, one git bundle per repository and a manifest with every HEAD.
|
Package backup writes a consistent snapshot of an install (D41, D54): the DB via VACUUM INTO (WAL-safe), config.toml, one git bundle per repository and a manifest with every HEAD. |
|
cloud
Package cloud keeps an encrypted copy of a backup in an S3-compatible bucket the owner controls (D70): AWS S3, Cloudflare R2, Backblaze B2, Wasabi, MinIO.
|
Package cloud keeps an encrypted copy of a backup in an S3-compatible bucket the owner controls (D70): AWS S3, Cloudflare R2, Backblaze B2, Wasabi, MinIO. |
|
config
Package config loads config.toml — the infrastructure layer of settings (D14): paths, listen addresses, process limits, hashing cost.
|
Package config loads config.toml — the infrastructure layer of settings (D14): paths, listen addresses, process limits, hashing cost. |
|
ghimport
Package ghimport brings a GitHub repository's issues, pull requests and comments into Codr (D72), from either the GitHub REST API (a mirror imported from github.com with its token) or the JSON Lines files the host's GitHub mirror keeps (issues.jsonl, pulls.jsonl, issue_comments.jsonl).
|
Package ghimport brings a GitHub repository's issues, pull requests and comments into Codr (D72), from either the GitHub REST API (a mirror imported from github.com with its token) or the JSON Lines files the host's GitHub mirror keeps (issues.jsonl, pulls.jsonl, issue_comments.jsonl). |
|
gitcmd
Package gitcmd runs the two git transport services (D2: exec the git binary, never parse packs ourselves).
|
Package gitcmd runs the two git transport services (D2: exec the git binary, never parse packs ourselves). |
|
gitread
Package gitread answers the web UI's read-only questions about a bare repository by running the git binary (D2).
|
Package gitread answers the web UI's read-only questions about a bare repository by running the git binary (D2). |
|
hooks
Package hooks is the git hook door of Codr (D9): git runs `codr hook pre-receive` (a three-line script written by Codr), the hook forwards the ref updates over a Unix socket in data/, and the serve process decides.
|
Package hooks is the git hook door of Codr (D9): git runs `codr hook pre-receive` (a three-line script written by Codr), the hook forwards the ref updates over a Unix socket in data/, and the serve process decides. |
|
i18n
Package i18n resolves message keys to text in the requested language.
|
Package i18n resolves message keys to text in the requested language. |
|
lfs
Package lfs stores Git LFS objects (D82): content-addressed files per repository under data/lfs, written only after their sha256 and size are checked.
|
Package lfs stores Git LFS objects (D82): content-addressed files per repository under data/lfs, written only after their sha256 and size are checked. |
|
mirror
Package mirror pulls a repository from a URL into a bare repo on disk and keeps it fresh (FR-08).
|
Package mirror pulls a repository from a URL into a bare repo on disk and keeps it fresh (FR-08). |
|
names
Package names is the single place that decides what a user or repository name may be.
|
Package names is the single place that decides what a user or repository name may be. |
|
notify
Package notify turns outbox events into notifications in the app and by email (D79).
|
Package notify turns outbox events into notifications in the app and by email (D79). |
|
oidc
Package oidc is a small OpenID Connect relying party (D91): discovery, the authorization code flow with PKCE, and ID token verification (RS256 / ES256 against the provider's JWKS).
|
Package oidc is a small OpenID Connect relying party (D91): discovery, the authorization code flow with PKCE, and ID token verification (RS256 / ES256 against the provider's JWKS). |
|
repos
Package repos manages bare repositories on disk.
|
Package repos manages bare repositories on disk. |
|
runner
Package runner is codr-runner (D89): a small CI runner outside the forge.
|
Package runner is codr-runner (D89): a small CI runner outside the forge. |
|
secret
Package secret seals small values (mirror tokens) with AES-256-GCM under the key in config.toml (auth.secret_key, PRD §9): a copy of the database alone never yields a token.
|
Package secret seals small values (mirror tokens) with AES-256-GCM under the key in config.toml (auth.secret_key, PRD §9): a copy of the database alone never yields a token. |
|
sshd
Package sshd is the SSH door of Codr: public-key auth only, no shell, no pty, no forwarding, and exactly one of two git commands per session (PRD §9).
|
Package sshd is the SSH door of Codr: public-key auth only, no shell, no pty, no forwarding, and exactly one of two git commands per session (PRD §9). |
|
store
Package store is the only package that speaks SQL.
|
Package store is the only package that speaks SQL. |
|
version
Package version holds the build identity of the binary.
|
Package version holds the build identity of the binary. |
|
web
Package web is the HTTPS door of Codr: /healthz and smart HTTP git under /<owner>/<repo>.git.
|
Package web is the HTTPS door of Codr: /healthz and smart HTTP git under /<owner>/<repo>.git. |
|
webhook
Package webhook delivers repository events to outside URLs, signed with HMAC-SHA256 (D78).
|
Package webhook delivers repository events to outside URLs, signed with HMAC-SHA256 (D78). |
|
wiki
Package wiki keeps a repository's wiki as its own bare git repository (<id>.wiki.git, D83): one Markdown file per page at the root of branch main.
|
Package wiki keeps a repository's wiki as its own bare git repository (<id>.wiki.git, D83): one Markdown file per page at the root of branch main. |
|
xref
Package xref finds references between issues, commits and pull requests (D87, FR-21): "owner/repo#n" links, and "fixes #n" style keywords that close an issue once the commit reaches the default branch or the pull request merges.
|
Package xref finds references between issues, commits and pull requests (D87, FR-21): "owner/repo#n" links, and "fixes #n" style keywords that close an issue once the commit reaches the default branch or the pull request merges. |
|
Package locale embeds the translation files.
|
Package locale embeds the translation files. |
Click to show internal directories.
Click to hide internal directories.


