From 6cf9ea957a0e54f257d10bc8d2d49efed412cfde Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Mon, 17 Jul 2023 16:23:33 -0700 Subject: [PATCH] Documentation in README for authentication, closes #3 --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index baf7308..4c23541 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,30 @@ Options: ``` +## Authentication + +`dclient` can handle API tokens for Datasette instances that require authentication. + +You can pass an API token to `query` using `-t/--token` like this: + +```bash +dclient query https://latest.datasette.io/fixtures "select * from facetable" -t dstok_mytoken +``` +You can also store tokens for a specific URL prefix. To always use `dstok_mytoken` for any URL on the `https://latest.datasette.io/` instance you can run this: +```bash +dclient auth add https://latest.datasette.io/ +``` +Then paste in the token and hit enter when prompted to do so. + +To list which URLs you have set tokens for, run the `auth list` command: +```bash +dclient auth list +``` +To delete the token for a specific URL, run `auth remove`: +```bash +dclient auth remove https://latest.datasette.io/ +``` + ## Aliases You can assign an alias to a Datasette database using the `dclient alias` command: