Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
89 commits
Select commit Hold shift + click to select a range
bbdd988
chore: add first files.
Aug 21, 2025
a48e482
chore: first draft of the REST API docs
Aug 25, 2025
496846a
chore: update and test.
Aug 27, 2025
0aa622e
chore: update and test.
Aug 27, 2025
5625bfd
Merge branch 'latest' into rest-api
billy-the-fish Aug 27, 2025
ddba359
Merge branch 'latest' into rest-api
billy-the-fish Sep 1, 2025
0141fbc
Merge branch 'latest' into rest-api
billy-the-fish Sep 3, 2025
20a0a27
Fix spec. Better examples and documentation
josesahad Sep 5, 2025
2f12d32
Fix replica set retrieval docs
josesahad Sep 5, 2025
b31c7e8
Merge branch 'latest' into rest-api
billy-the-fish Sep 9, 2025
81b21fc
chore: few small updates.
Sep 9, 2025
39a62ae
chore: few small updates.
Sep 9, 2025
15cc114
Merge branch 'latest' into rest-api
billy-the-fish Sep 10, 2025
131c385
Merge branch 'latest' into rest-api
billy-the-fish Sep 11, 2025
3238fef
chore: change title to give space for the CLI
Sep 11, 2025
df580c9
Merge branch 'latest' into rest-api
billy-the-fish Sep 25, 2025
fece7f1
Merge branch 'latest' into rest-api
billy-the-fish Sep 29, 2025
d77f554
chore: commit for pull from latest.
Sep 29, 2025
50daa6f
Merge branch 'latest' of https://github.com/timescale/docs into 424-d…
Sep 29, 2025
cd73149
chore: cli docs.
Sep 29, 2025
6c24803
Apply suggestions from code review
billy-the-fish Sep 30, 2025
a45b764
chore: updates on review.
Sep 30, 2025
f932dee
Merge branch 'latest' into rest-api
billy-the-fish Sep 30, 2025
1fac045
chore: updates on review.
Sep 30, 2025
6c51d65
Merge branch 'rest-api' of https://github.com/timescale/docs into res…
Sep 30, 2025
a11bf56
Merge branch 'rest-api' into 424-docs-rfcadd-docs-for-the-cli
billy-the-fish Sep 30, 2025
c511d2e
chore: first changes.
Oct 1, 2025
aede7bf
chore: few more changes.
Oct 1, 2025
fed7892
chore: few more changes.
Oct 2, 2025
2739921
chore: few more changes.
Oct 2, 2025
2368b74
chore: more updates.
Oct 2, 2025
0c0df01
chore: updates on review.
Oct 2, 2025
e3d921b
chore: updates on review.
Oct 2, 2025
427b4f7
chore: MCP stuff for an AI assistant
billy-the-fish Oct 3, 2025
03c5c75
chore: MCP stuff for HTTP
billy-the-fish Oct 3, 2025
b0d3810
chore: MCP stuff for HTTP
billy-the-fish Oct 3, 2025
1d241c6
chore: MCP stuff for HTTP
billy-the-fish Oct 3, 2025
76ca855
chore: MCP stuff for HTTP
billy-the-fish Oct 3, 2025
deaee7a
chore: updates on review.
Oct 6, 2025
b63c87d
chore: first draft.
Oct 6, 2025
a7e03a6
chore: remove tiger agents doc, wrong branch.
Oct 6, 2025
35af3c8
Merge branch '503-cli-mcp-agent-milestone-branch' into 425-docs-rfcad…
billy-the-fish Oct 14, 2025
0d422a8
chore: update service creation JSON.
Oct 15, 2025
660f3e9
chore: update cli install.
Oct 15, 2025
c7b4855
chore: update cli page.
Oct 15, 2025
66994ea
chore: update cli page.
Oct 15, 2025
8600f24
chore: updates.
Oct 16, 2025
fe60176
chore: Clean up the MCP docs
Oct 16, 2025
5a01714
chore: hmmm
Oct 16, 2025
43cdb79
chore: clean metadata
Oct 16, 2025
97fe5c0
chore: try removing a partial.
Oct 16, 2025
706ad3c
chore: add one back.
Oct 16, 2025
f29eb0d
chore: add one back.
Oct 16, 2025
a83a027
chore: add one back.
Oct 16, 2025
20b0104
chore: MacOS
Oct 17, 2025
0097d2a
Apply suggestions from code review
billy-the-fish Oct 17, 2025
33add2f
Update _partials/_devops-cli-get-started.md
billy-the-fish Oct 17, 2025
2f2c061
chore: updates on review.
Oct 17, 2025
197f8a4
chore: updates on review.
Oct 17, 2025
074b299
Apply suggestions from code review
billy-the-fish Oct 20, 2025
cdee68d
Apply suggestions from code review
billy-the-fish Oct 20, 2025
d010dd4
Update _partials/_devops-cli-get-started.md
billy-the-fish Oct 20, 2025
a764301
Update _partials/_devops-cli-get-started.md
billy-the-fish Oct 20, 2025
9a6a517
Update _partials/_devops-cli-install.md
billy-the-fish Oct 20, 2025
4bdb152
Update api/api-reference.md
billy-the-fish Oct 20, 2025
ef57963
chore: Update on review.
billy-the-fish Oct 20, 2025
4c5b56a
chore: Update on review.
billy-the-fish Oct 20, 2025
6bd8dfd
chore: Update on review.
billy-the-fish Oct 20, 2025
6333b96
Apply suggestions from code review
billy-the-fish Oct 20, 2025
834ed76
Update _partials/_devops-cli-reference.md
billy-the-fish Oct 20, 2025
377fe91
Update api/api-reference.md
billy-the-fish Oct 20, 2025
a2f85fa
Update api/api-reference.md
billy-the-fish Oct 20, 2025
cc3e920
Update _partials/_devops-cli-reference.md
billy-the-fish Oct 20, 2025
048c137
Apply suggestions from code review
billy-the-fish Oct 20, 2025
b1619b2
Update _partials/_devops-cli-reference.md
billy-the-fish Oct 20, 2025
c7af580
chore: Update on review.
billy-the-fish Oct 20, 2025
524dea8
chore: Update on review.
billy-the-fish Oct 20, 2025
323f957
Update _partials/_devops-cli-reference.md
billy-the-fish Oct 20, 2025
dcebd48
Update _partials/_devops-cli-reference.md
billy-the-fish Oct 20, 2025
fc7f3bb
Update _partials/_devops-cli-reference.md
billy-the-fish Oct 20, 2025
4be36fa
chore: Update on review.
billy-the-fish Oct 20, 2025
4da6ef8
chore: Update on review.
billy-the-fish Oct 20, 2025
ea98276
chore: Update on review.
billy-the-fish Oct 20, 2025
789e06b
Apply suggestions from code review
billy-the-fish Oct 20, 2025
c35a6b6
chore: Update on review.
billy-the-fish Oct 20, 2025
520cf20
chore: Update on review.
billy-the-fish Oct 20, 2025
f599a10
Merge branch '503-cli-mcp-agent-milestone-branch' into 425-docs-rfcad…
billy-the-fish Oct 21, 2025
0cd881e
chore: Updates on review.
Oct 21, 2025
5367796
Apply suggestions from code review
billy-the-fish Oct 21, 2025
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
197 changes: 30 additions & 167 deletions _partials/_devops-cli-get-started.md

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions _partials/_devops-cli-global-flags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

| Flag | Default | Description |
|-------------------------------|-------------------|-----------------------------------------------------------------------------|
| `--analytics` | `true` | Set to `false` to disable usage analytics |
| `--color ` | `true` | Set to `false` to disable colored output |
| `--config-dir` string | `.config/tiger` | Set the directory that holds `config.yaml` |
| `--debug` | No debugging | Enable debug logging |
| `--help` | - | Print help about the current command. For example, `tiger service --help` |
| `--password-storage` string | keyring | Set the password storage method. Options are `keyring`, `pgpass`, or `none` |
| `--service-id` string | - | Set the $SERVICE_LONG to manage |
| ` --skip-update-check ` | - | Do not check if a new version of $CLI_LONG is available|
117 changes: 117 additions & 0 deletions _partials/_devops-cli-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
1. **Install $CLI_LONG**

Use the terminal to install the $CLI_SHORT:
<Tabs label="Install Tiger CLI" persistKey="os">

<Tab title="Debian" label="debian">

```shell
curl -s https://packagecloud.io/install/repositories/timescale/tiger-cli/script.deb.sh | sudo os=any dist=any bash
sudo apt-get install tiger-cli
```

</Tab>

<Tab title="Ubuntu" label="ubuntu">

```shell
curl -s https://packagecloud.io/install/repositories/timescale/tiger-cli/script.deb.sh | sudo os=any dist=any bash
sudo apt-get install tiger-cli
```
</Tab>

<Tab title="Red Hat" label="redhat">

```shell
curl -s https://packagecloud.io/install/repositories/timescale/tiger-cli/script.rpm.sh | sudo os=rpm_any dist=rpm_any bash
sudo yum install tiger-cli
```

</Tab>

<Tab title="Fedora" label="fedora">

```shell
curl -s https://packagecloud.io/install/repositories/timescale/tiger-cli/script.rpm.sh | sudo os=rpm_any dist=rpm_any bash
sudo yum install tiger-cli
```

</Tab>

<Tab title="MacOS" label="macos">

```shell
brew install --cask timescale/tap/tiger-cli
```

</Tab>

<Tab title="x-platform" label="xplatform">

```shell
curl -fsSL https://cli.tigerdata.com | sh
```

</Tab>

</Tabs>

1. **Set up API credentials**

1. Log $CLI_LONG into your $ACCOUNT_LONG:

```shell
tiger auth login
```
$CLI_LONG opens $CONSOLE_SHORT in your browser. Log in, then click `Authorize`.

You can have a maximum of 10 active client credentials. If you get an error, open [credentials][rest-api-credentials]
and delete an unused credential.

1. Select a $PROJECT_LONG:

```terminaloutput
Auth URL is: https://console.cloud.timescale.com/oauth/authorize?client_id=lotsOfURLstuff
Opening browser for authentication...
Select a project:

> 1. Tiger Project (tgrproject)
2. YourCompany (Company wide project) (cpnproject)
3. YourCompany Department (dptproject)

Use ↑/↓ arrows or number keys to navigate, enter to select, q to quit
```
If only one $PROJECT_SHORT is associated with your $ACCOUNT_SHORT, this step is not shown.

Where possible, $CLI_LONG stores your authentication information in the system keychain/credential manager.
If that fails, the credentials are stored in `~/.config/tiger/credentials` with restricted file permissions (600).
By default, $CLI_LONG stores your configuration in `~/.config/tiger/config.yaml`.

1. **Test your authenticated connection to $CLOUD_LONG by listing $SERVICE_SHORTs**

```bash
tiger service list
```

This call returns something like:
- No $SERVICE_SHORTs:
```terminaloutput
🏜️ No services found! Your project is looking a bit empty.
🚀 Ready to get started? Create your first service with: tiger service create
```
- One or more $SERVICE_SHORTs:

```terminaloutput
┌────────────┬─────────────────────┬────────┬─────────────┬──────────────┬──────────────────┐
│ SERVICE ID │ NAME │ STATUS │ TYPE │ REGION │ CREATED │
├────────────┼─────────────────────┼────────┼─────────────┼──────────────┼──────────────────┤
│ tgrservice │ tiger-agent-service │ READY │ TIMESCALEDB │ eu-central-1 │ 2025-09-25 16:09 │
└────────────┴─────────────────────┴────────┴─────────────┴──────────────┴──────────────────┘
```


[rest-api-reference]: /api/:currentVersion:/api-reference/
[rest-api-credentials]: https://console.cloud.timescale.com/dashboard/settings
[get-project-id]: /integrations/:currentVersion:/find-connection-details/#find-your-project-and-service-id
[create-client-credentials]: /integrations/:currentVersion:/find-connection-details/#create-client-credentials
[curl]: https://curl.se/
Loading