@osvaldoandrade/tikti-cli 0.2.54 → 0.2.55
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 +15 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @osvaldoandrade/tikti-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
tikti-cli is the admin CLI for Tikti. It ships as a prebuilt Go binary that the npm postinstall hook downloads from GitHub Releases, so no Go toolchain is required on the target machine. The binary supports tenant management, authentication, and SAML 2.0 federation commands.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -14,6 +14,19 @@ npm install -g @osvaldoandrade/tikti-cli
|
|
|
14
14
|
npm install -g @osvaldoandrade/tikti-cli@latest
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
tikti-cli init --base-url http://localhost:8080 --api-key <key> --tenant <tid>
|
|
21
|
+
tikti-cli auth login --email admin@example.com
|
|
22
|
+
tikti-cli saml metadata
|
|
23
|
+
tikti-cli saml idp register --tenant <tenantId> --metadata-url <url>
|
|
24
|
+
tikti-cli saml idp show --tenant <tenantId>
|
|
25
|
+
tikti-cli saml keys rotate
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
`init` persists connection details for subsequent commands. `auth login` authenticates against the Tikti API. The `saml` subcommands manage SAML 2.0 federation: `metadata` prints the SP metadata document, `idp register` adds an identity provider to a tenant, `idp show` displays the registered identity provider, and `keys rotate` replaces the SP signing keypair.
|
|
29
|
+
|
|
17
30
|
## Notes
|
|
18
31
|
|
|
19
|
-
- If the repository is private,
|
|
32
|
+
- If the repository is private, set `GITHUB_TOKEN` or `GH_TOKEN` so the postinstall binary download can authenticate with GitHub.
|