Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion COMMANDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,16 @@ altertable login [options]
| `--data-plane-url <DATA-PLANE-URL>` | Data-plane base URL saved to the profile only on successful login. Default: https://api.altertable.ai |
| `--allow-insecure-http` | Allow http:// URLs other than localhost for --control-plane-url (for development only) |
| `--replace-profile` | Store the login session in the current profile instead of switching profiles |
| `--service-account <LABEL>` | Create an environment-scoped service account with this label and store its access token instead of your login session |
| `--scope <MODE\|CATALOG:MODE,...>` | Request a service account limited to `ro` or `rw` on every catalog, or to specific catalogs, e.g. `analytics:ro,staging:rw` (requires --service-account). The catalog access the server actually grants is reported on success. |

**Examples**

```bash
altertable login
altertable login --replace-profile
altertable login --service-account "CI Bot" --scope analytics:ro
altertable login --service-account "CI Bot" --scope ro
```

### `altertable logout`
Expand All @@ -54,13 +58,20 @@ Remove stored credentials and settings for all profiles.
**Usage**

```bash
altertable logout
altertable logout [options]
```

**Options**

| Option | Description |
| --- | --- |
| `--except-current` | Keep the current profile and remove every other profile |

**Examples**

```bash
altertable logout
altertable logout --except-current
```

### `altertable profile`
Expand Down
44 changes: 40 additions & 4 deletions cli-reference.json
Original file line number Diff line number Diff line change
Expand Up @@ -163,11 +163,35 @@
"repeatable": false,
"scope": "command",
"values": []
},
{
"name": "service-account",
"aliases": [],
"type": "string",
"description": "Create an environment-scoped service account with this label and store its access token instead of your login session",
"required": false,
"repeatable": false,
"scope": "command",
"values": [],
"valueHint": "LABEL"
},
{
"name": "scope",
"aliases": [],
"type": "string",
"description": "Request a service account limited to `ro` or `rw` on every catalog, or to specific catalogs, e.g. `analytics:ro,staging:rw` (requires --service-account). The catalog access the server actually grants is reported on success.",
"required": false,
"repeatable": false,
"scope": "command",
"values": [],
"valueHint": "MODE|CATALOG:MODE,..."
}
],
"examples": [
"altertable login",
"altertable login --replace-profile"
"altertable login --replace-profile",
"altertable login --service-account \"CI Bot\" --scope analytics:ro",
"altertable login --service-account \"CI Bot\" --scope ro"
],
"subcommands": []
},
Expand All @@ -176,13 +200,25 @@
"command": "altertable logout",
"description": "Remove stored credentials and settings for all profiles.",
"usage": [
"altertable logout"
"altertable logout [options]"
],
"aliases": [],
"arguments": [],
"options": [],
"options": [
{
"name": "except-current",
"aliases": [],
"type": "boolean",
"description": "Keep the current profile and remove every other profile",
"required": false,
"repeatable": false,
"scope": "command",
"values": []
}
],
"examples": [
"altertable logout"
"altertable logout",
"altertable logout --except-current"
],
"subcommands": []
},
Expand Down
Loading