@unisonlabs/sixminute-admin 0.0.0 → 0.1.597
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 +67 -1
- package/dist/sixminute-admin.mjs +7771 -0
- package/package.json +22 -3
package/README.md
CHANGED
|
@@ -1 +1,67 @@
|
|
|
1
|
-
|
|
1
|
+
# sixminute-admin
|
|
2
|
+
|
|
3
|
+
The Sixminute operator tool. Every command calls the Sixminute API's operator routes, signed in as
|
|
4
|
+
you. An operator account is required; without one every command answers 403.
|
|
5
|
+
|
|
6
|
+
## Install
|
|
7
|
+
|
|
8
|
+
On a Mac:
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
npm install -g @unisonlabs/sixminute-admin
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
On Windows 11, install Node first if it is missing, then the same line:
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
winget install OpenJS.NodeJS.LTS
|
|
18
|
+
npm install -g @unisonlabs/sixminute-admin
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The build that matches staging installs with `@next` on the end:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
npm install -g @unisonlabs/sixminute-admin@next
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Sign in
|
|
28
|
+
|
|
29
|
+
Once per environment (`production`, `staging` or `local`):
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
sixminute-admin login --env production
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The tool prints a code and opens the browser; confirm the code there. If you are asked for an
|
|
36
|
+
organisation, choose "Sixminute operators". The sign-in is kept on this machine, readable by you
|
|
37
|
+
alone. `sixminute-admin whoami --env production` shows it; `sixminute-admin logout --env production`
|
|
38
|
+
deletes it.
|
|
39
|
+
|
|
40
|
+
## Check the tool matches the API
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
sixminute-admin doctor --env production
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
It prints `matches`, or the line that updates the tool. A tool that no longer matches the API is
|
|
47
|
+
refused with the same line on every command.
|
|
48
|
+
|
|
49
|
+
## One example per group
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
sixminute-admin firm list --env production
|
|
53
|
+
sixminute-admin tenant list --env production
|
|
54
|
+
sixminute-admin tier set --env production --tenant tenant_... --tier standard
|
|
55
|
+
sixminute-admin versions --env production --tenant tenant_...
|
|
56
|
+
sixminute-admin entries purge --env staging --tenant tenant_... --author member_... --demo --dry-run
|
|
57
|
+
sixminute-admin research export --env production --tenant tenant_... --from 2026-09-01 --to 2026-09-08 --out ./out
|
|
58
|
+
sixminute-admin activity-type list --env production --tenant tenant_...
|
|
59
|
+
sixminute-admin member list --env production --tenant tenant_...
|
|
60
|
+
sixminute-admin matters import --env production --tenant tenant_... --from-file matters.json
|
|
61
|
+
sixminute-admin connector status --env production --firm tenant_...
|
|
62
|
+
sixminute-admin audit --env production --limit 20
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
`sixminute-admin --help` lists every command, with the warnings on the destructive ones.
|
|
66
|
+
`client create`, `matter create` and `matters import` work only on a firm marked internal (our own).
|
|
67
|
+
`sixminute-admin --version` prints the version and the API commit it was built from.
|