Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 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
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
80 changes: 80 additions & 0 deletions _partials/_devops-cli-get-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
import RESTPrereqs from "versionContent/_partials/_prereqs-cloud-account-only.mdx";
import CLIINSTALL from "versionContent/_partials/_devops-cli-install.mdx";
import CLIREF from "versionContent/_partials/_devops-cli-reference.mdx";

$CLI_LONG is a command-line interface that you use to manage $CLOUD_LONG resources
including VPCs, services, read replicas, and related infrastructure. $CLI_LONG calls $REST_LONG to communicate with
$CLOUD_LONG.

This page shows you how to install and set up secure authentication for $CLI_LONG, then create your first
service.

## Prerequisites

<RESTPrereqs />


## Install and configure $CLI_LONG

<Procedure>

<CLIINSTALL />

</Procedure>


## Create your first $SERVICE_LONG

Create a new $SERVICE_LONG using $CLI_LONG:

<Procedure>

1. **Submit a service creation request**
```shell
tiger service create
```
$CLOUD_LONG creates a Development environment for you. That is, no delete protection, high-availability, spooling or
read-replication. You see something like:
```terminaloutput
🚀 Creating service 'db-11111' (auto-generated name)...
✅ Service creation request accepted!
📋 Service ID: happyservice
🔐 Password saved to system keyring for automatic authentication
🎯 Set service 'happyservice' as default service.
⏳ Waiting for service to be ready (wait timeout: 30m0s)...
⏳ Service status: QUEUED...
🎉 Service is ready and running!
```
This $SERVICE_SHORT is set as default by the $CLI_SHORT.

1. **Check the $CLI_SHORT configuration**
```shell
tiger config show
```
You see something like:
```terminaloutput
api_url: https://console.cloud.timescale.com/public/api/v1
console_url: https://console.cloud.timescale.com
gateway_url: https://console.cloud.timescale.com/api
docs_mcp: true
docs_mcp_url: https://mcp.tigerdata.com/docs
project_id: tgrproject
service_id: tgrservice
output: table
analytics: true
password_storage: keyring
debug: false
config_dir: /Users/<username>/.config/tiger
```

</Procedure>

And that is it, you are ready to use $CLI_LONG to manage your $SERVICE_SHORTs in $CLOUD_LONG.

<CLIREF />

[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/
10 changes: 10 additions & 0 deletions _partials/_devops-cli-global-flags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

| Flag | Default | Description |
|---------------------------|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| --analytics | `true` | Set to `false` to disable usage analytics. |
| --config-dir string | `.config/tiger` | Set the directory that holds `config.yaml` |
| --debug | No debugging | Enable debug logging |
| -o, --output string | table | Set the output format. Options are `json`, `yaml`, or `table` |
| --password-storage string | keyring | Set the password storage method. Options are `keyring`, `pgpass`, or `none` |
| --project-id string | - | Set the $PROJECT_LONG to manage. |
| --service-id string | - | Set the $SERVICE_LONG to manage. |
114 changes: 114 additions & 0 deletions _partials/_devops-cli-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
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://tiger-cli-releases.s3.amazonaws.com/install/install.sh | 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. Login, then click `Authorize`.

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 key is stored in `~/.config/tiger/api-key` with restricted file permissions (600).
$CLI_LONG stores your configuration in `~/.config/tiger/config.yaml`.

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

```bash
tiger service list
```

This call returns something like:
- No services:
```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 services:

```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