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
29 changes: 0 additions & 29 deletions .eslintrc.json

This file was deleted.

113 changes: 113 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# Tigris CLI Installation Guide

## npm

Requires Node.js 18+.

```sh
npm install -g @tigrisdata/cli
```

### Uninstall (npm)

```sh
npm uninstall -g @tigrisdata/cli
```

---

## Standalone Binary

No dependencies required. Downloads a self-contained executable.

### macOS / Linux

```sh
curl -fsSL https://raw.githubusercontent.com/tigrisdata/cli/main/scripts/install.sh | sh
```

#### Options

| Environment Variable | Description |
| -------------------- | --------------------------------------------------- |
| `TIGRIS_VERSION` | Install a specific version (e.g., `v2.9.0`) |
| `TIGRIS_INSTALL_DIR` | Custom install directory (default: `~/.tigris/bin`) |

Example:

```sh
TIGRIS_VERSION=v2.9.0 curl -fsSL https://raw.githubusercontent.com/tigrisdata/cli/main/scripts/install.sh | sh
```

#### Uninstall (macOS / Linux)

```sh
rm -rf ~/.tigris/bin
```

Remove the PATH entry from your shell config (`~/.zshrc`, `~/.bashrc`, etc.):

```sh
# Delete these lines:
# Tigris CLI
export PATH="$HOME/.tigris/bin:$PATH"
```

### Windows (PowerShell)

```powershell
irm https://raw.githubusercontent.com/tigrisdata/cli/main/scripts/install.ps1 | iex
```

#### Options

| Environment Variable | Description |
| -------------------- | --------------------------------------------------- |
| `TIGRIS_VERSION` | Install a specific version (e.g., `v2.9.0`) |
| `TIGRIS_INSTALL_DIR` | Custom install directory (default: `~\.tigris\bin`) |

Example:

```powershell
$env:TIGRIS_VERSION = "v2.9.0"; irm https://raw.githubusercontent.com/tigrisdata/cli/main/scripts/install.ps1 | iex
```

#### Uninstall (Windows)

```powershell
Remove-Item -Recurse -Force "$HOME\.tigris\bin"
```

Remove PATH entry (run in PowerShell as Administrator):

```powershell
$installDir = "$HOME\.tigris\bin"
$userPath = [Environment]::GetEnvironmentVariable("Path", "User")
$newPath = ($userPath -split ';' | Where-Object { $_ -ne $installDir }) -join ';'
[Environment]::SetEnvironmentVariable("Path", $newPath, "User")
```

---

## Verify Installation

After installation, verify it works:

```sh
tigris --version
tigris help
```

You can also use `t3` as a shorthand:

```sh
t3 --version
```

## Getting Started

```sh
tigris login
```

For more information, visit the [documentation](https://www.tigrisdata.com/docs/cli/).
21 changes: 21 additions & 0 deletions eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import eslint from "@eslint/js";
import tseslint from "typescript-eslint";

export default tseslint.config(
eslint.configs.recommended,
...tseslint.configs.recommended,
{
rules: {
"@typescript-eslint/no-unused-vars": "error",
"@typescript-eslint/no-explicit-any": "warn",
"@typescript-eslint/explicit-function-return-type": "off",
"@typescript-eslint/explicit-module-boundary-types": "off",
"@typescript-eslint/no-inferrable-types": "off",
"prefer-const": "error",
"no-var": "error",
},
},
{
ignores: ["dist/", "node_modules/", "**/*.cjs"],
},
);
Loading