README.md

Turso CLI

This is the command line interface (CLI) to Turso.

Documentation

There is reference documentation available.

For a guided walkthrough, follow the Turso CLI tutorial.

Installation

Package manager

Homebrew (macOS, Linux, WSL)

brew install tursodatabase/tap/turso

Also remember to configure homebrew shell completions if you haven't already done so.

To upgrade an existing installation of the CLI, run:

brew upgrade turso

Install script

curl -sSfL https://get.tur.so/install.sh | bash

Go

go install github.com/tursodatabase/turso-cli/cmd/turso@latest

Building from source

cd cmd/turso && go install

Usage

Authentication

If you are a new user, you can # with:

turso auth #

If you already have an account, authenticate with:

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:

turso db create

Or you can specify the name of the database with:

turso db create <database name>

Start SQL shell

You can start an interactive SQL shell similar to sqlite3 with:

turso db shell <database name>

Run SQL command without interactive shell

You can also run a command without using the interactive SQL shell:

turso db shell <database name> <sql query>

Replicate database

First, list available locations and pick a location you want to replicate to:

turso db locations

Then, to replicate a database, run:

turso db replicate <database name> <location>

List databases

To list your databases, run:

turso db list

Delete database

turso db destroy <database name>

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