112 lines
4.2 KiB
Markdown
112 lines
4.2 KiB
Markdown
# @idp.global/cli
|
|
|
|
Terminal client for `idp.global`.
|
|
|
|
It wraps the same typed backend used by the web app and SDK, but stores credentials on disk so you can inspect accounts, sessions, orgs, and admin state from the shell.
|
|
|
|
## Issue Reporting and Security
|
|
|
|
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
pnpm add -g @idp.global/cli
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
idp login
|
|
idp whoami
|
|
idp orgs
|
|
idp sessions
|
|
```
|
|
|
|
## Commands
|
|
|
|
| Command | Purpose |
|
|
| --- | --- |
|
|
| `idp login` | Prompt for email and password |
|
|
| `idp login-token` | Prompt for an API token |
|
|
| `idp logout` | Remove local credentials and try server-side logout |
|
|
| `idp whoami` | Print the current user |
|
|
| `idp sessions` | List active sessions |
|
|
| `idp revoke --session <session-id>` | Revoke a session |
|
|
| `idp orgs` | List organizations for the current user |
|
|
| `idp orgs-create` | Interactively create an organization |
|
|
| `idp members --org <org-id>` | List members for an organization |
|
|
| `idp invite --org <org-id> --email user@example.com` | Invite a member |
|
|
| `idp admin-check` | Check global admin status |
|
|
| `idp admin-apps` | List global app stats |
|
|
| `idp admin-suspend --user <user-id>` | Suspend a user |
|
|
|
|
## Configuration
|
|
|
|
The CLI reads `IDP_URL` and defaults to `https://idp.global`.
|
|
|
|
```bash
|
|
IDP_URL=http://localhost:2999 idp whoami
|
|
```
|
|
|
|
Credentials are stored in:
|
|
|
|
```text
|
|
~/.idp-global/credentials.json
|
|
```
|
|
|
|
## Programmatic Usage
|
|
|
|
```ts
|
|
import { IdpCli } from '@idp.global/cli';
|
|
|
|
const cli = new IdpCli({
|
|
idpBaseUrl: 'http://localhost:2999',
|
|
});
|
|
|
|
await cli.loginWithPassword('user@example.com', 'secret');
|
|
|
|
const me = await cli.whoami();
|
|
const orgs = await cli.getOrganizations();
|
|
|
|
console.log(me?.data?.email);
|
|
console.log(orgs?.organizations.length);
|
|
|
|
await cli.disconnect();
|
|
```
|
|
|
|
## What The Class Exposes
|
|
|
|
- `loginWithPassword()` and `loginWithApiToken()`
|
|
- `refreshJwt()` and `logout()`
|
|
- `whoami()`, `getSessions()`, and `revokeSession()`
|
|
- `getOrganizations()`, `createOrganization()`, `getOrgMembers()`, and `inviteMember()`
|
|
- `checkGlobalAdmin()`, `getGlobalAppStats()`, and `suspendUser()`
|
|
|
|
## Implementation Notes
|
|
|
|
- The CLI connects to the backend websocket surface at `/typedrequest`.
|
|
- It uses file-based credentials instead of browser storage.
|
|
- `orgs-create` first checks availability, then creates the organization.
|
|
|
|
## License and Legal Information
|
|
|
|
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](../license) file.
|
|
|
|
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
|
|
### Trademarks
|
|
|
|
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
|
|
|
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
|
|
|
### Company Information
|
|
|
|
Task Venture Capital GmbH
|
|
Registered at District Court Bremen HRB 35230 HB, Germany
|
|
|
|
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
|
|
|
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|