Document every repo in Sphinx, catalog PDFs, and verae-ops
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
Add missing package READMEs, expand Sphinx to all runtime modules, publish a LaTeX/PDF README book, and add verae-ops for Docker, Proxmox, VMs, dedicated hardware, and service linking. Catalog defaults to public PDF links for each module README and samples.
This commit is contained in:
parent
5ad3222def
commit
e401635fd6
222 changed files with 4498 additions and 123 deletions
62
docs/sphinx/modules/verae-fleet/cli.md
Normal file
62
docs/sphinx/modules/verae-fleet/cli.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
# `verae-fleet/cli`
|
||||
|
||||
**Package:** `verae-fleet`
|
||||
**Source:** `packages/verae-fleet/src/cli.js`
|
||||
**Lines:** 146
|
||||
|
||||
## What this module is
|
||||
|
||||
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
|
||||
|
||||
## Exports
|
||||
|
||||
_No named `export` / `module.exports` keys detected._
|
||||
|
||||
## Types / interfaces / classes
|
||||
|
||||
_None extracted._
|
||||
|
||||
## Functions
|
||||
|
||||
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|
||||
|------|------------|---------------------|---------|-----------------------------|
|
||||
| `print` | `obj` | — | `unknown` | see Call graph |
|
||||
| `help` | `(none)` | — | `unknown` | see Call graph |
|
||||
| `api` | `method, pathname` | — | `unknown` | see Call graph |
|
||||
| `main` | `(none)` | — | `unknown` | see Call graph |
|
||||
|
||||
## Methods (class / object)
|
||||
|
||||
| Name | Parameters |
|
||||
|------|------------|
|
||||
| `print` | ``verae-fleet
|
||||
|
||||
list services, config files, replica min/max
|
||||
serve start floors + monitor + UI ${BASE}/
|
||||
monitor same without printing extra
|
||||
status GET daemon status
|
||||
start <service> turn on, spawn up to min
|
||||
stop <service|instance> turn off (service disable` |
|
||||
| `print` | `r.body` |
|
||||
| `print` | `{ error: err.message, hint: 'Is `verae-fleet serve` running?' }` |
|
||||
|
||||
## What it imports / requires
|
||||
|
||||
- `node:http`
|
||||
- `./load.js`
|
||||
- `./supervisor.js`
|
||||
- `./monitor.js`
|
||||
- `./server.js`
|
||||
|
||||
## Call graph (identifiers invoked)
|
||||
|
||||
`loadFleet`, `slice`, `print`, `write`, `stringify`, `help`, `off`, `pause`, `json`, `identityFile`, `login`, `api`, `request`, `on`, `push`, `concat`, `toString`, `resolve`, `parse`, `end`, `main`, `listServices`, `padEnd`, `padStart`, `import`, `find`, `sshCheck`, `keys`, `startService`, `tick`, `start`, `startControlServer`, `async`, `stop`, `stopAll`, `exit`, `test`
|
||||
|
||||
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.
|
||||
|
||||
## Return values (how to read this)
|
||||
|
||||
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
|
||||
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
|
||||
- Pricing functions return integer **cents** on `Quote.totalCents`.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue