arketix 0.2.0 → 0.3.0
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/README.md +2 -0
- package/dist/arketix.js +23920 -4857
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,12 +11,14 @@ arketix crm companies get --rut 76.123.456-0 --json
|
|
|
11
11
|
arketix crm activities log <companyId> --type call --date 2026-10-22 --summary "Llamada con operaciones"
|
|
12
12
|
arketix crm contacts remove <contactId> --confirm
|
|
13
13
|
arketix call crm.opportunities.update @input.json
|
|
14
|
+
arketix --org personal finance summary --currency GBP
|
|
14
15
|
arketix help crm opportunities
|
|
15
16
|
```
|
|
16
17
|
|
|
17
18
|
- **Flags come from each operation's input.** `ownerId` is `--owner-id`, enums are choices, objects and arrays take JSON, `--input '<json>'` passes the whole input. An operation with exactly one required id also takes it as one trailing word.
|
|
18
19
|
- **Output.** People get a table for a list and `key: value` lines otherwise. `--json` prints one line: the output, or `{"error":{"code","message","retryable"}}`.
|
|
19
20
|
- **Sign-in.** `login` keeps the token in the OS keychain. `ARKETIX_TOKEN` overrides it. `--env prod` (default, https://erp.arketix.cl) or `local` (http://localhost:3417); `ARKETIX_URL` points anywhere else. A token kept by 0.1.x for https://crm.admin.acredix.cl still signs in to prod; `logout` forgets both.
|
|
21
|
+
- **Workspaces.** A person may belong to several workspaces (organizations). `--org <slug>` makes every request of this run act in that one, `ARKETIX_ORG` when the flag is absent; it is per run, so jobs running side by side never move each other. Without either, a call acts in the workspace you last chose (the sidebar, or `arketix account workspace switch --slug <slug>`, which an agent member cannot run), else your first. `arketix whoami` names it; `arketix account me` lists them all. A workspace you don't belong to exits 10.
|
|
20
22
|
- **Catalogue.** Every command, and help for one, asks Arketix ERP for its list of operations. The list is cached per server version and CLI release in `~/.cache/arketix`, which only saves the `tools/list` call while the server's version is unchanged. Nothing falls back to it: when the server can't be reached or gives no usable answer, the command exits 9, and a refused token exits with its code. `arketix`, `arketix help` and the built-ins' help need no token and no connection, so they list only the built-ins; `arketix help crm` lists the CRM module's commands.
|
|
21
23
|
|
|
22
24
|
Exit codes: 0 ok, 1 other error, 2 usage, 3 unauthenticated, 4 read-only token, 6 confirmation required, 7 not in catalogue, 8 rate limited, 9 connection lost (a write may have run), 10 forbidden, 12 input invalid.
|