Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tursodatabase/turso-cli
Command line interface to Turso.
https://github.com/tursodatabase/turso-cli
database edge serverless
Last synced: 3 days ago
JSON representation
Command line interface to Turso.
- Host: GitHub
- URL: https://github.com/tursodatabase/turso-cli
- Owner: tursodatabase
- License: mit
- Created: 2022-12-16T15:04:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T16:21:53.000Z (20 days ago)
- Last Synced: 2024-12-13T12:12:25.699Z (10 days ago)
- Topics: database, edge, serverless
- Language: Go
- Homepage: https://turso.tech
- Size: 7.94 MB
- Stars: 234
- Watchers: 7
- Forks: 38
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Turso CLI
[](https://github.com/tursodatabase/turso-cli/actions/workflows/go.yml)
[](https://github.com/tursodatabase/turso-cli/blob/main/LICENSE)
This is the command line interface (CLI) to Turso.
## Documentation
There is [reference documentation](https://docs.turso.tech/reference/turso-cli)
available.
For a guided walkthrough, follow the
[Turso CLI tutorial](https://docs.turso.tech/tutorials/get-started-turso-cli).
## Installation
### Package manager
#### [Homebrew](https://brew.sh) (macOS, Linux, WSL)
```bash
brew install tursodatabase/tap/turso
```
Also remember to configure `homebrew`
[shell completions](https://docs.brew.sh/Shell-Completion) if you haven't
already done so.
To upgrade an existing installation of the CLI, run:
```bash
brew upgrade turso
```
### Install script
```bash
curl -sSfL https://get.tur.so/install.sh | bash
```
### Go
```bash
go install github.com/tursodatabase/turso-cli/cmd/turso@latest
```
### Building from source
```bash
cd cmd/turso && go install
```
## Usage
### Authentication
If you are a new user, you can sign up with:
```bash
turso auth signup
```
If you already have an account, authenticate with:
```bash
turso auth login
```
You are taken to a web page in your default browser to authenticate via GitHub.
After successfully authenticated, `turso auth login` receives an access token
that is stored on your settings file.
### Create database
To create a database with a generated name, run:
```bash
turso db create
```
Or you can specify the name of the database with:
```bash
turso db create
```
### Start SQL shell
You can start an interactive SQL shell similar to `sqlite3` with:
```bash
turso db shell
```
### Run SQL command without interactive shell
You can also run a command without using the interactive SQL shell:
```bash
turso db shell
```
### Replicate database
First, list available locations and pick a location you want to replicate to:
```bash
turso db locations
```
Then, to replicate a database, run:
```bash
turso db replicate
```
### List databases
To list your databases, run:
```bash
turso db list
```
### Delete database
```bash
turso db destroy
```
## Settings
The `turso` program keeps settings in your local machine in the following base
directory in `turso/settings.json` file:
| OS | Config directory |
| ----- | ----------------------------------------- |
| Linux | `$XDG_CONFIG_HOME` or `$HOME/.config` |
| macOS | `$HOME/Library/Application Support/turso` |