mirror of
https://github.com/simonw/dclient.git
synced 2026-07-31 14:34:12 +02:00
3f3221fdd3
Update examples to use v2 command syntax with -i flag and alias defaults. Add quick start section showing alias add/default/default-db workflow. Add introspection commands section. Add environment.md to docs toctree. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
75 lines
2.2 KiB
Markdown
75 lines
2.2 KiB
Markdown
# dclient
|
|
|
|
[](https://pypi.org/project/dclient/)
|
|
[](https://github.com/simonw/dclient/releases)
|
|
[](https://github.com/simonw/dclient/actions?query=workflow%3ATest)
|
|
[](https://github.com/simonw/dclient/blob/master/LICENSE)
|
|
|
|
A client CLI utility for [Datasette](https://datasette.io/) instances.
|
|
|
|
Much of the functionality requires Datasette 1.0a2 or higher.
|
|
|
|
## Things you can do with dclient
|
|
|
|
- Run SQL queries against Datasette and return the results as JSON
|
|
- Introspect databases, tables, plugins, and schema
|
|
- Run queries against authenticated Datasette instances
|
|
- Create aliases and set default instances/databases for convenient access
|
|
- Insert and upsert data using the [write API](https://docs.datasette.io/en/latest/json_api.html#the-json-write-api) (Datasette 1.0 alpha or higher)
|
|
|
|
## Installation
|
|
|
|
Install this tool using `pip`:
|
|
```bash
|
|
pip install dclient
|
|
```
|
|
If you want to install it in the same virtual environment as Datasette (to use it as a plugin) you can instead run:
|
|
```bash
|
|
datasette install dclient
|
|
```
|
|
## Quick start
|
|
|
|
Add an alias for a Datasette instance:
|
|
```bash
|
|
dclient alias add latest https://latest.datasette.io
|
|
dclient alias default latest
|
|
dclient alias default-db latest fixtures
|
|
```
|
|
Now run queries directly:
|
|
```bash
|
|
dclient "select * from facetable limit 1"
|
|
```
|
|
Or be explicit:
|
|
```bash
|
|
dclient query fixtures "select * from facetable limit 1" -i latest
|
|
```
|
|
|
|
## Introspection
|
|
|
|
```bash
|
|
dclient databases
|
|
dclient tables
|
|
dclient plugins
|
|
dclient schema facetable
|
|
```
|
|
|
|
## Documentation
|
|
|
|
Visit **[dclient.datasette.io](https://dclient.datasette.io)** for full documentation on using this tool.
|
|
|
|
## Development
|
|
|
|
To contribute to this tool, first checkout the code. Then create a new virtual environment:
|
|
```bash
|
|
cd dclient
|
|
python -m venv venv
|
|
source venv/bin/activate
|
|
```
|
|
Now install the dependencies and test dependencies:
|
|
```bash
|
|
pip install -e '.[test]'
|
|
```
|
|
To run the tests:
|
|
```bash
|
|
pytest
|
|
```
|