@lotics/cli 0.318.50 → 0.320.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +5 -6
- package/README.md +1 -4
- package/dist/src/cli.js +204 -95
- package/docs/agent_surface.md +10 -5
- package/docs/app_architecture.md +20 -12
- package/docs/{first_build.md → build.md} +12 -17
- package/docs/data_model.md +17 -7
- package/docs/design.md +51 -22
- package/docs/document_templates.md +37 -9
- package/docs/examples.md +73 -42
- package/docs/field_values.md +2 -0
- package/docs/getting_started.md +6 -4
- package/docs/workflows.md +75 -12
- package/docs/working_in_a_workspace.md +3 -3
- package/package.json +1 -1
- package/docs/building_an_app.md +0 -252
package/AGENTS.md
CHANGED
|
@@ -9,15 +9,14 @@ conventions are, and where the traps are.
|
|
|
9
9
|
| `lotics tools` · `lotics tools <name>` | The agent tool registry and one tool's full JSON Schema. |
|
|
10
10
|
| `lotics docs` · `lotics docs <area>[/<section>]` · `lotics docs [<area>] --grep <text>` | This CLI's references, carried inside it so each describes the binary answering. Capped at a page: a doc that does not fit hands back its opening and the addresses into it, so the next call is smaller than the last. A page the copy lacks — one the server added since this binary was built, which a refusal can cite — is read from the server's `docs` tool with this machine's credential, and so is every `--grep`, over the references the server serves. A custom-code app's SDK reference is `node_modules/@lotics/app-sdk/AGENTS.md` inside the app. |
|
|
11
11
|
| `lotics docs reference` · `lotics docs reference/<section>` | The keys of a table document and the components of an app tree: a table's fields keyed by alias, how a row of each table is recognised (`records`), and the apps stated over them. Every key, every field type with the config it needs, the rules, and a worked example. |
|
|
12
|
-
| `lotics docs design` · `lotics docs design/<section>` | Designing an app — the treatment each kind of row takes with the `reference` page stating its keys, the visual bar,
|
|
12
|
+
| `lotics docs design` · `lotics docs design/<section>` | Designing an app — the treatment each kind of row takes with the `reference` page stating its keys, the visual bar, looking at what a write built, and the rubric a build answers. Opens on the visual bar; a finding names its section. |
|
|
13
13
|
| `lotics docs examples` · `lotics docs examples/<treatment>` | Each treatment worked through in an app of a complete workspace: the job, the props to read, where it is the wrong one, and the excerpt. |
|
|
14
14
|
| [docs/getting_started.md](./docs/getting_started.md) | What a workspace holds, and the one page to open for each job: building a workspace, changing an app, a rule on a table, a document, data and questions, a connected service, sharing. The first page an agent outside the product reads. |
|
|
15
|
-
| [docs/
|
|
16
|
-
| [docs/app_architecture.md](./docs/app_architecture.md) |
|
|
15
|
+
| [docs/build.md](./docs/build.md) | A workspace or an app built call by call — tables with a check, the paper, the app, what the owner will ask an agent, the owner's rows, pressing it — in one worked example, at any time: an app added or changed weeks later starts there too. |
|
|
16
|
+
| [docs/app_architecture.md](./docs/app_architecture.md) | Which apps a business needs, one per main entity, with a worked split; who gets each, and which rows each person reads. |
|
|
17
17
|
| [docs/working_in_a_workspace.md](./docs/working_in_a_workspace.md) | The right means for each job once the apps exist: an app's act for a business operation, a record write for data entry, a query for a figure the business defines, a count for the rest. |
|
|
18
|
-
| [docs/building_an_app.md](./docs/building_an_app.md) | The SEQUENCE — clarify, tables, apps, prove, look — for an app stated as a tree and for a custom-code app. Read it once before starting an app. Looking is `lotics run screenshot_app '<json>' -o <dir>`, which saves each PNG and its text snapshot there. |
|
|
19
18
|
| [docs/cli_reference.md](./docs/cli_reference.md) | Per-command contracts, flags, exit codes, and gotchas — the detail `--help` compresses. |
|
|
20
|
-
| [docs/data_model.md](./docs/data_model.md) | Tables, their fields, and how they relate — one fact per column, one table per kind of thing and the NAME-OVERLAP probe that says when a split has broken, one vocabulary wherever values are copied, a copy boundary that accounts for every source field, provenance as a link, a declared natural key, history as rows, and why derived DEPTH costs more than row count; then the choices around a field's type, and how a field is changed (a list replaces whole, what refuses a deletion, what `force` consents to). Separate from
|
|
19
|
+
| [docs/data_model.md](./docs/data_model.md) | Tables, their fields, and how they relate — one fact per column, one table per kind of thing and the NAME-OVERLAP probe that says when a split has broken, one vocabulary wherever values are copied, a copy boundary that accounts for every source field, provenance as a link, a declared natural key, history as rows, and why derived DEPTH costs more than row count; then the choices around a field's type, and how a field is changed (a list replaces whole, what refuses a deletion, what `force` consents to). Separate from build because every workspace starts with tables and many never get an app. |
|
|
21
20
|
| [docs/filters.md](./docs/filters.md) | The one filter grammar every filter-taking tool, view and rollup reads — conditions, groups, and the operators per field type. |
|
|
22
21
|
| [docs/field_values.md](./docs/field_values.md) | The value each field type takes in a write. |
|
|
23
22
|
| [docs/workflows.md](./docs/workflows.md) | Writing a workflow body — triggers, steps, what an expression reads, the helpers, approvals and agent steps, and table checks. |
|
|
@@ -124,7 +123,7 @@ something exists, read `lotics --help` § COMMANDS — the whole section, not a
|
|
|
124
123
|
`acknowledge_breaking_api_change` carries it out and snapshots the break as a new contract version.
|
|
125
124
|
- **Exposure is per app, all or nothing** — a public share or a key reaches every alias an app
|
|
126
125
|
declares, so what outsiders may call is a second app over the same tables
|
|
127
|
-
([docs/
|
|
126
|
+
([docs/app_architecture.md](./docs/app_architecture.md)).
|
|
128
127
|
- **`--print-created` / `--cleanup` on any call that reports `side_effects`.** The first prints the
|
|
129
128
|
records created plus a paste-ready cleanup plan and what cannot be auto-undone; the second runs
|
|
130
129
|
those deletes (records only — never files, integrations or notifications). Neither is a rollback.
|
package/README.md
CHANGED
|
@@ -30,10 +30,7 @@ package (reachable at `node_modules/@lotics/cli/docs/*.md` once installed):
|
|
|
30
30
|
|
|
31
31
|
- [`docs/getting_started.md`](docs/getting_started.md) — what a workspace holds and the one page
|
|
32
32
|
to open for each job.
|
|
33
|
-
- [`docs/
|
|
34
|
-
- [`docs/building_an_app.md`](docs/building_an_app.md) — building an app end to end: an app
|
|
35
|
-
stated as a tree and written with `set_app`, or a custom-code app on
|
|
36
|
-
`@lotics/app-sdk`. Read it once before starting an app.
|
|
33
|
+
- [`docs/build.md`](docs/build.md) — a workspace or an app built call by call: tables with a check, the paper, the app, the owner's rows, pressing it.
|
|
37
34
|
- [`docs/document_templates.md`](docs/document_templates.md) — generate finished documents
|
|
38
35
|
(PDF, Excel, Word, email) by filling reusable templates: the five template types, the
|
|
39
36
|
create → generate → chain lifecycle, and the marker capabilities.
|