arketix 0.0.0-stage → 0.1.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 +21 -2
- package/dist/arketix.js +36916 -0
- package/package.json +37 -4
package/README.md
CHANGED
|
@@ -1,3 +1,22 @@
|
|
|
1
|
-
#
|
|
1
|
+
# arketix
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The command line of the Arketix control room (https://crm.admin.acredix.cl), for founders and agents. Its commands come from the CRM's operations, so a new operation is a new command with no new release.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npm i -g arketix
|
|
7
|
+
arketix login # paste a token from Acredix Admin → Tokens de acceso
|
|
8
|
+
arketix whoami
|
|
9
|
+
arketix crm companies list --status customer
|
|
10
|
+
arketix crm companies get --rut 76.123.456-0 --json
|
|
11
|
+
arketix crm activities log <companyId> --type call --date 2026-10-22 --summary "Llamada con operaciones"
|
|
12
|
+
arketix crm contacts remove <contactId> --confirm
|
|
13
|
+
arketix call crm.opportunities.update @input.json
|
|
14
|
+
arketix help crm opportunities
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
- **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
|
+
- **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
|
+
- **Sign-in.** `login` keeps the token in the OS keychain. `ARKETIX_TOKEN` overrides it. `--env prod` (default) or `local` (http://localhost:3417); `ARKETIX_URL` points anywhere else.
|
|
20
|
+
- **Catalogue.** The list of operations is cached per server version in `~/.cache/arketix`, so help works offline.
|
|
21
|
+
|
|
22
|
+
Exit codes: 0 ok, 1 other CRM 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.
|