dclient/docs/index.md

dclient

A client CLI utility for Datasette instances

Installation

Install dclient using pip (or pipx:

pip install dclient

As a Datasette plugin

If you also have Datasette installed in the same environment it will register itself as a command plugin.

This means you can run any of these commands using datasette client instead, like this:

datasette client --help
datasette client query https://latest.datasette.io/fixtures "select * from facetable limit 1"

You can install it into Datasette this way using:

datasette install dclient

Running queries

You can run SQL queries against a Datasette instance like this:

dclient query https://latest.datasette.io/fixtures "select * from facetable limit 1"

Output:

[
  {
    "pk": 1,
    "created": "2019-01-14 08:00:00",
    "planet_int": 1,
    "on_earth": 1,
    "state": "CA",
    "_city_id": 1,
    "_neighborhood": "Mission",
    "tags": "[\"tag1\", \"tag2\"]",
    "complex_array": "[{\"foo\": \"bar\"}]",
    "distinct_some_null": "one",
    "n": "n1"
  }
]

dclient query --help

Usage: dclient query [OPTIONS] URL SQL

  Run a SQL query against a Datasette database URL

  Returns a JSON array of objects

Options:
  -t, --token TEXT  API token
  --help            Show this message and exit.

Contents

---
maxdepth: 3
---
aliases
authentication