Skip to content

Clarify TigerData names and links #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mfreed merged 1 commit into from
Oct 3, 2025
+5 −9
Merged

Clarify TigerData names and links #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 5 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Tiger CLI

Tiger CLI is a command-line interface for managing TigerData Cloud Platform resources. Built as a single Go binary, it provides comprehensive tools for managing database services, VPCs, replicas, and related infrastructure components.
Tiger CLI is a command-line interface for managing Tiger, the modern database cloud. Built as a single Go binary, it provides comprehensive tools for managing database services, VPCs, replicas, and related infrastructure components.

## Quick Start During Development
```bash
# Clone the repository
git clone https://github.com/tigerdata/tiger-cli.git
git clone https://github.com/timescale/tiger-cli.git
cd tiger-cli
git checkout <branch>

Expand All @@ -15,10 +15,6 @@ go install ./cmd/tiger
# (Optional) Set up the savannah-public endpoint
# for prod (default)
tiger config set api_url https://console.cloud.timescale.com/public/api/v1
# for dev
tiger config set api_url https://console.dev.timescale.com/public/api/v1
tiger config set console_url https://console.dev.timescale.com
tiger config set gateway_url https://console.dev.timescale.com/api
Comment on lines -18 to -21
Copy link
Member

@nathanjcochran nathanjcochran Oct 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I agree we should remove this from the public README, we probably do need to document this somewhere so our engineers know how to run it against the dev environment.

Maybe I'll make a development.md file in a /docs folder or something like that 🤔. Feel free to merge, this is mostly just a note-to-self.

# for local
tiger config set api_url http://localhost:8080/public/api/v1

Expand Down Expand Up @@ -88,7 +84,7 @@ tiger --help

### Environment Variables

- `TIGER_API_URL`: Base URL for TigerData API (default: https://api.tigerdata.com/public/v1)
- `TIGER_API_URL`: Base URL for Tiger API (default: https://console.cloud.timescale.com/public/api/v1)
- `TIGER_PROJECT_ID`: Default project ID to use
- `TIGER_SERVICE_ID`: Default service ID to use
- `TIGER_CONFIG_DIR`: Configuration directory (default: ~/.config/tiger)
Expand All @@ -111,7 +107,7 @@ tiger --help
### Building from Source

```bash
git clone https://github.com/tigerdata/tiger-cli.git
git clone https://github.com/timescale/tiger-cli.git
cd tiger-cli
go build -o bin/tiger ./cmd/tiger
```
Expand All @@ -128,7 +124,7 @@ go test -v ./...

### Integration Testing

Integration tests execute real API calls against a TigerData environment to validate end-to-end functionality. These tests require valid credentials and will create/delete actual resources.
Integration tests execute real API calls against a Tiger environment to validate end-to-end functionality. These tests require valid credentials and will create/delete actual resources.

#### Setup

Expand Down