Directories
¶
| Path | Synopsis |
|---|---|
|
Package browser opens a URL in the person's default browser with the platform's own opener: xdg-open on Linux and the BSDs, open on macOS, and url.dll's FileProtocolHandler through rundll32 on Windows (which, unlike `cmd /c start`, needs no quoting of & in a URL).
|
Package browser opens a URL in the person's default browser with the platform's own opener: xdg-open on Linux and the BSDs, open on macOS, and url.dll's FileProtocolHandler through rundll32 on Windows (which, unlike `cmd /c start`, needs no quoting of & in a URL). |
|
Package cli is ovdb's command-line presentation of the onboarding and configuration capabilities: `ovdb server …`, `ovdb open`, `ovdb config …` and `ovdb status`.
|
Package cli is ovdb's command-line presentation of the onboarding and configuration capabilities: `ovdb server …`, `ovdb open`, `ovdb config …` and `ovdb status`. |
|
Package client is how every presentation (CLI now, TUI in 1c, and the shared rules the web console relies on) reaches the local OVDB server.
|
Package client is how every presentation (CLI now, TUI in 1c, and the shared rules the web console relies on) reaches the local OVDB server. |
|
Package covergate is a scoped, exact statement-coverage gate.
|
Package covergate is a scoped, exact statement-coverage gate. |
|
Package datapath is the file-like path people and agents type to name a place inside a database: `/lists/to-buy/items`.
|
Package datapath is the file-like path people and agents type to name a place inside a database: `/lists/to-buy/items`. |
|
Package envelope is the one error shape every ovdb interface shares: the local API writes it, the CLI prints it (as JSON with --json, or as the "Couldn't …/Why/What you can do" problem pattern otherwise), and later the TUI and web console render it.
|
Package envelope is the one error shape every ovdb interface shares: the local API writes it, the CLI prints it (as JSON with --json, or as the "Couldn't …/Why/What you can do" problem pattern otherwise), and later the TUI and web console render it. |
|
Package libguard reads the source of a library ovdb builds on, for the tests that hold ovdb's text and branches to the values that library can produce.
|
Package libguard reads the source of a library ovdb builds on, for the tests that hold ovdb's text and branches to the values that library can produce. |
|
Package localserver is the HTTP side of the local OVDB server: the hardening middleware chain, the local API (/api/local/v1/…), the landing page, and the openvaultdb-go data API (/v1/…) mounted behind them.
|
Package localserver is the HTTP side of the local OVDB server: the hardening middleware chain, the local API (/api/local/v1/…), the landing page, and the openvaultdb-go data API (/v1/…) mounted behind them. |
|
Package parity is the capability registry: per row of the capability matrix in spec/features/configuration-parity, the CLI command, TUI screen, web route and local API endpoints that implement it, and the documented exceptions for the cells that are missing on purpose.
|
Package parity is the capability registry: per row of the capability matrix in spec/features/configuration-parity, the CLI command, TUI screen, web route and local API endpoints that implement it, and the documented exceptions for the cells that are missing on purpose. |
|
Package paths resolves where ovdb keeps its configuration, runtime state and data, and creates those directories owner-only — but only the ones it creates itself.
|
Package paths resolves where ovdb keeps its configuration, runtime state and data, and creates those directories owner-only — but only the ones it creates itself. |
|
Package porttest leases TCP ports to tests that start a server on a port they must know beforehand: the server is a separate process (a detached `ovdb server run`, `ovdb serve`), or the port is the one a command line, an environment variable or a configuration names, so the test cannot hand the server a listener it already holds (the runtime's own check dials the port, Windows has no inherited sockets, and 0 is no valid port for a command line).
|
Package porttest leases TCP ports to tests that start a server on a port they must know beforehand: the server is a separate process (a detached `ovdb server run`, `ovdb serve`), or the port is the one a command line, an environment variable or a configuration names, so the test cannot hand the server a listener it already holds (the runtime's own check dials the port, Windows has no inherited sockets, and 0 is no valid port for a command line). |
|
Package preview is the single switch for ovdb's unreleased onboarding surface.
|
Package preview is the single switch for ovdb's unreleased onboarding surface. |
|
publisher
|
|
|
checkcmd
Package checkcmd is `ovdb publisher check`: it checks the Git repository in a directory, as committed at HEAD, with the Publisher profile of package repo, and prints what it finds for a person or, with --json, as a document for a CI job.
|
Package checkcmd is `ovdb publisher check`: it checks the Git repository in a directory, as committed at HEAD, with the Publisher profile of package repo, and prints what it finds for a person or, with --json, as a document for a CI job. |
|
datarights
Package datarights validates the opt-in publication contract.
|
Package datarights validates the opt-in publication contract. |
|
exitcode
Package exitcode is the error type that the publisher commands return for a failure that is not a finding: bad usage, or an environment that cannot run the command.
|
Package exitcode is the error type that the publisher commands return for a failure that is not a finding: bad usage, or an environment that cannot run the command. |
|
manifest
Package manifest judges a publisher's OVDB.md and OVDB manifest (ovdb.yaml) as pure functions over the bytes of the two documents: no file system, no git, no network.
|
Package manifest judges a publisher's OVDB.md and OVDB manifest (ovdb.yaml) as pure functions over the bytes of the two documents: no file system, no git, no network. |
|
repo
Package repo judges a whole repository against the Chinook checker: OVDB.md and the manifests it lists, and the files an own-form manifest names, are tracked regular files of the commit at HEAD, as committed and never from the working tree; every manifest is judged with package manifest; publisher.repository is the --repository given; and what the model file and the meaning file say agrees with the manifest (the module, the entities and the recordsets, the id, the license and the models: entry).
|
Package repo judges a whole repository against the Chinook checker: OVDB.md and the manifests it lists, and the files an own-form manifest names, are tracked regular files of the commit at HEAD, as committed and never from the working tree; every manifest is judged with package manifest; publisher.repository is the --repository given; and what the model file and the meaning file say agrees with the manifest (the module, the entities and the recordsets, the id, the license and the models: entry). |
|
rules
Package rules holds the pure rules that a publisher's OVDB manifest is held to: what a published URL, a homepage, a database id, a commit, a repository, a path inside a repository, an engine name and a licence id may look like, and how two claimed addresses compare.
|
Package rules holds the pure rules that a publisher's OVDB manifest is held to: what a published URL, a homepage, a database id, a commit, a repository, a path inside a repository, an engine name and a licence id may look like, and how two claimed addresses compare. |
|
Package redact removes credentials from text before it leaves the server process: error reasons, status, mounts.json and server.log lines.
|
Package redact removes credentials from text before it leaves the server process: error reasons, status, mounts.json and server.log lines. |
|
Package runtime owns the local OVDB server's process lifecycle and the files in the runtime directory: server.json, the instance secret, the home lock and server.log.
|
Package runtime owns the local OVDB server's process lifecycle and the files in the runtime directory: server.json, the instance secret, the home lock and server.log. |
|
Package setup holds the onboarding and configuration services: the documents the local API returns and the pure reads that build the same documents from state files when no server is running.
|
Package setup holds the onboarding and configuration services: the documents the local API returns and the pure reads that build the same documents from state files when no server is running. |
|
dbcontext
Package dbcontext is the one resolver for "which database and path does this command act on" (decision 0008, spec/features/database-context-navigation REQ:use-sets-scoped-context and REQ:context-lookup).
|
Package dbcontext is the one resolver for "which database and path does this command act on" (decision 0008, spec/features/database-context-navigation REQ:use-sets-scoped-context and REQ:context-lookup). |
|
demo
Package demo is the built-in TODO demo service (spec/features/todo-demo, decision 0010): two lists, To buy and To watch, in a schemaless inGitDB database registered as `todo` at <data home>/demos/todo, and the documents `ovdb demo install|open|status`, the TUI, the web console and the TODO app render.
|
Package demo is the built-in TODO demo service (spec/features/todo-demo, decision 0010): two lists, To buy and To watch, in a schemaless inGitDB database registered as `todo` at <data home>/demos/todo, and the documents `ovdb demo install|open|status`, the TUI, the web console and the TODO app render. |
|
explore
Package explore is Explore data (spec/features/explore-data-handoff): the intent-first menu that hands database access to DataTug CLI or names DataTug.app's honest limitation, never running DataTug itself.
|
Package explore is Explore data (spec/features/explore-data-handoff): the intent-first menu that hands database access to DataTug CLI or names DataTug.app's honest limitation, never running DataTug itself. |
|
skills
Package skills is the AI agent skills service (spec/features/ai-agent-skills, capabilities 20 and 21): the two Agent Skills embedded from skills/, where each AI agent (harness) keeps them, and installing one skill with github.com/strongo/cli-helpers/skillsync.
|
Package skills is the AI agent skills service (spec/features/ai-agent-skills, capabilities 20 and 21): the two Agent Skills embedded from skills/, where each AI agent (harness) keeps them, and installing one skill with github.com/strongo/cli-helpers/skillsync. |
|
skills/skillstest
Package skillstest is the test support of the packages that show or install AI agent skills: what an interrupted install leaves behind.
|
Package skillstest is the test support of the packages that show or install AI agent skills: what an interrupted install leaves behind. |
|
Package telemetry is ovdb's opt-in usage statistics (spec/features/ telemetry-consent, decision 0009): the closed event set, the consent state stored in config.yaml, the forced-off conditions evaluated in the sending process, channel detection and a small synchronous PostHog (EU) batch sender.
|
Package telemetry is ovdb's opt-in usage statistics (spec/features/ telemetry-consent, decision 0009): the closed event set, the consent state stored in config.yaml, the forced-off conditions evaluated in the sending process, channel detection and a small synchronous PostHog (EU) batch sender. |
|
Package tui is ovdb's terminal UI: one root Model with named screens (Home, OVDB server, Settings, Result, Problem) that call internal/client.Local exactly as the CLI does — client.Local is the single place that decides server-vs-files and mismatch rules, and every screen here goes through it rather than duplicating that logic.
|
Package tui is ovdb's terminal UI: one root Model with named screens (Home, OVDB server, Settings, Result, Problem) that call internal/client.Local exactly as the CLI does — client.Local is the single place that decides server-vs-files and mismatch rules, and every screen here goes through it rather than duplicating that logic. |
Click to show internal directories.
Click to hide internal directories.