Documentation
¶
Overview ¶
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. Its test fails when a named command or endpoint does not exist.
A row stays Implemented=false — and its surface stays behind the preview gate — until every non-exception cell exists (REQ:increments-keep-parity). Increment 1a filled the CLI and API cells of rows 2–7, 1b the web routes (web/routes.json), and 1c (this one) adds row 1 and every TUI cell of rows 1–7 — completing parity for rows 1–7. Increment 2 adds rows 8, 9, 11 and 12 in every interface.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Rows = []Row{ {ID: "1", Capability: "Guided first run", CLI: []string{"ovdb"}, TUI: "home", Web: "/", Implemented: true}, {ID: "2", Capability: "Whole-setup status", CLI: []string{"ovdb status"}, TUI: "home", Web: "/", API: []string{"GET /api/local/v1/status", "GET /api/local/v1/home"}, Implemented: true}, {ID: "3", Capability: "Start server", CLI: []string{"ovdb server start"}, TUI: "server", Exceptions: []string{"E1"}, Implemented: true}, {ID: "4", Capability: "Server status", CLI: []string{"ovdb server status"}, TUI: "server", Web: "/server", API: []string{"GET /api/local/v1/server"}, Implemented: true}, {ID: "5", Capability: "Stop or restart server", CLI: []string{"ovdb server stop", "ovdb server restart"}, TUI: "server", API: []string{"POST /api/local/v1/server/shutdown"}, Exceptions: []string{"E2"}, Implemented: true}, {ID: "6", Capability: "Open web console (login link)", CLI: []string{"ovdb open"}, TUI: "server", API: []string{"POST /api/local/v1/login-links"}, Exceptions: []string{"E1"}, Implemented: true}, {ID: "7", Capability: "Change server port", CLI: []string{"ovdb config set", "ovdb config get"}, TUI: "settings", Web: "/settings", API: []string{"GET /api/local/v1/config", "PUT /api/local/v1/config"}, Implemented: true}, {ID: "8", Capability: "Storage choices", CLI: []string{"ovdb engines"}, TUI: "create", Web: "/databases/new", API: []string{"GET /api/local/v1/engines"}, Implemented: true}, {ID: "9", Capability: "Create database (inGitDB, SQLite)", CLI: []string{"ovdb databases create"}, TUI: "create", Web: "/databases/new", API: []string{"POST /api/local/v1/databases"}, Implemented: true}, {ID: "10", Capability: "Connect existing inGitDB folder or SQLite file", CLI: []string{"ovdb databases connect"}, TUI: "connect", Web: "/databases/connect", API: []string{"POST /api/local/v1/databases/connect"}, Implemented: true}, {ID: "10a", Capability: "Connect with a manifest file (any engine)", CLI: []string{"ovdb databases connect"}, TUI: "connect", Web: "/databases/connect", API: []string{"POST /api/local/v1/databases/connect"}, Implemented: true}, {ID: "11", Capability: "List databases", CLI: []string{"ovdb databases"}, TUI: "databases", Web: "/databases", API: []string{"GET /api/local/v1/databases"}, Implemented: true}, {ID: "12", Capability: "Remove database registration", CLI: []string{"ovdb databases remove"}, TUI: "databases", Web: "/databases", API: []string{"DELETE /api/local/v1/databases/{id}"}, Implemented: true}, {ID: "12a", Capability: "Reload database registration", CLI: []string{"ovdb databases reload"}, TUI: "databases", Web: "/databases", API: []string{"POST /api/local/v1/databases/{id}/reload", "POST /api/local/v1/databases/reload"}, Implemented: true}, {ID: "13", Capability: "Choose current database", CLI: []string{"ovdb use"}, TUI: "databases", Web: "/databases", API: []string{"PUT /api/local/v1/context"}, Exceptions: []string{"E3"}, Implemented: true}, {ID: "14", Capability: "Show current database", CLI: []string{"ovdb use", "ovdb pwd"}, TUI: "home", Web: "/", API: []string{"GET /api/local/v1/context", "GET /api/local/v1/home", "GET /api/local/v1/status"}, Implemented: true}, {ID: "15", Capability: "Browse data (read-only)", CLI: []string{"ovdb list", "ovdb get"}, TUI: "browse", Web: "/browse", API: []string{"GET /v1/databases/{db}", "POST /v1/databases/{db}/query", "POST /v1/databases/{db}/dtql", "GET /v1/databases/{db}/records/{key}"}, Implemented: true}, {ID: "16", Capability: "Navigate paths", CLI: []string{"ovdb cd", "ovdb pwd"}, API: []string{"GET /api/local/v1/context", "PUT /api/local/v1/context", "GET /v1/databases/{db}", "POST /v1/databases/{db}/query", "GET /v1/databases/{db}/records/{key}"}, Exceptions: []string{"E4"}, Implemented: true}, {ID: "17", Capability: "Write records", CLI: []string{"ovdb set", "ovdb add", "ovdb delete"}, API: []string{"PUT /v1/databases/{db}/records/{key}", "PATCH /v1/databases/{db}/records/{key}", "POST /v1/databases/{db}/records/{key}", "DELETE /v1/databases/{db}/records/{key}"}, Exceptions: []string{"E5"}, Implemented: true}, {ID: "18", Capability: "Install TODO demo", CLI: []string{"ovdb demo install", "ovdb demo status"}, TUI: "demo", Web: "/demo", API: []string{"GET /api/local/v1/demo", "POST /api/local/v1/demo/install"}, Implemented: true}, {ID: "19", Capability: "Open TODO app", CLI: []string{"ovdb demo open"}, TUI: "demo", Web: "/demo", API: []string{"GET /api/local/v1/demo", "POST /api/local/v1/login-links"}, Implemented: true}, {ID: "20", Capability: "List AI skills", CLI: []string{"ovdb skills list"}, TUI: "skills", Web: "/skills", API: []string{"GET /api/local/v1/skills"}, Exceptions: []string{"E6"}, Implemented: true}, {ID: "21", Capability: "Install AI skill", CLI: []string{"ovdb skills install"}, TUI: "skills", Web: "/skills", API: []string{"GET /api/local/v1/skills", "POST /api/local/v1/skills/install"}, Exceptions: []string{"E6"}, Implemented: true}, {ID: "25", Capability: "Access tokens and browser app origins", CLI: []string{"ovdb token create", "ovdb token list", "ovdb token revoke", "ovdb config set", "ovdb config get"}, API: []string{"POST /v1/tokens", "GET /v1/tokens", "DELETE /v1/tokens/{id}", "GET /api/local/v1/config", "PUT /api/local/v1/config"}, Exceptions: []string{"E7"}, Implemented: true}, {ID: "22", Capability: "Explore data (DataTug guidance)", CLI: []string{"ovdb explore"}, TUI: "explore", Web: "/explore", API: []string{"POST /api/local/v1/explore/datatug"}, Implemented: true}, {ID: "23", Capability: "Telemetry status", CLI: []string{"ovdb telemetry status"}, TUI: "settings", Web: "/settings", API: []string{"GET /api/local/v1/telemetry"}, Implemented: true}, {ID: "24", Capability: "Turn telemetry on or off", CLI: []string{"ovdb telemetry enable", "ovdb telemetry disable"}, TUI: "settings", Web: "/settings", API: []string{"PUT /api/local/v1/telemetry", "POST /api/local/v1/telemetry/events"}, Exceptions: []string{"E6"}, Implemented: true}, }
Rows is the registry, in matrix order.
Functions ¶
This section is empty.
Types ¶
type Row ¶
type Row struct {
ID string
Capability string
CLI []string // command paths, e.g. "ovdb server start"
TUI string // screen id; "" while pending
Web string // route; "" while pending
API []string // "METHOD path"
Exceptions []string // E1…E7 for intentionally missing cells
// Implemented is true once every non-exception cell exists and is tested.
Implemented bool
}
Row is one capability.
Source Files
Click to show internal directories.
Click to hide internal directories.