github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Ran cog, refs #1789

Browse source
This commit is contained in:
Simon Willison 2022-08-23 11:40:36 -07:00
commit 456dc155d4
1 changed files with 51 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

95
docs/cli-reference.rst
View file

@ -84,48 +84,53 @@ Once started you can access it at ``http://localhost:8001``
Serve up specified SQLite database files with a web UI Serve up specified SQLite database files with a web UI
Options: Options:
-i, --immutable PATH Database files to open in immutable mode -i, --immutable PATH Database files to open in immutable mode
-h, --host TEXT Host for server. Defaults to 127.0.0.1 which means -h, --host TEXT Host for server. Defaults to 127.0.0.1 which
only connections from the local machine will be means only connections from the local machine
allowed. Use 0.0.0.0 to listen to all IPs and allow will be allowed. Use 0.0.0.0 to listen to all
access from other machines. IPs and allow access from other machines.
-p, --port INTEGER RANGE Port for server, defaults to 8001. Use -p 0 to -p, --port INTEGER RANGE Port for server, defaults to 8001. Use -p 0 to
automatically assign an available port. automatically assign an available port.
[0<=x<=65535] [0<=x<=65535]
--uds TEXT Bind to a Unix domain socket --uds TEXT Bind to a Unix domain socket
--reload Automatically reload if code or metadata change --reload Automatically reload if code or metadata
detected - useful for development change detected - useful for development
--cors Enable CORS by serving Access-Control-Allow-Origin: --cors Enable CORS by serving Access-Control-Allow-
* Origin: *
--load-extension TEXT Path to a SQLite extension to load --load-extension PATH:ENTRYPOINT?
--inspect-file TEXT Path to JSON file created using "datasette inspect" Path to a SQLite extension to load, and
-m, --metadata FILENAME Path to JSON/YAML file containing license/source optional entrypoint
metadata --inspect-file TEXT Path to JSON file created using "datasette
--template-dir DIRECTORY Path to directory containing custom templates inspect"
--plugins-dir DIRECTORY Path to directory containing custom plugins -m, --metadata FILENAME Path to JSON/YAML file containing
--static MOUNT:DIRECTORY Serve static files from this directory at /MOUNT/... license/source metadata
--memory Make /_memory database available --template-dir DIRECTORY Path to directory containing custom templates
--config CONFIG Deprecated: set config option using --plugins-dir DIRECTORY Path to directory containing custom plugins
configname:value. Use --setting instead. --static MOUNT:DIRECTORY Serve static files from this directory at
--setting SETTING... Setting, see /MOUNT/...
docs.datasette.io/en/stable/settings.html --memory Make /_memory database available
--secret TEXT Secret used for signing secure values, such as --config CONFIG Deprecated: set config option using
signed cookies configname:value. Use --setting instead.
--root Output URL that sets a cookie authenticating the --setting SETTING... Setting, see
root user docs.datasette.io/en/stable/settings.html
--get TEXT Run an HTTP GET request against this path, print --secret TEXT Secret used for signing secure values, such as
results and exit signed cookies
--version-note TEXT Additional note to show on /-/versions --root Output URL that sets a cookie authenticating
--help-settings Show available settings the root user
--pdb Launch debugger on any errors --get TEXT Run an HTTP GET request against this path,
-o, --open Open Datasette in your web browser print results and exit
--create Create database files if they do not exist --version-note TEXT Additional note to show on /-/versions
--crossdb Enable cross-database joins using the /_memory --help-settings Show available settings
database --pdb Launch debugger on any errors
--nolock Ignore locking, open locked files in read-only mode -o, --open Open Datasette in your web browser
--ssl-keyfile TEXT SSL key file --create Create database files if they do not exist
--ssl-certfile TEXT SSL certificate file --crossdb Enable cross-database joins using the /_memory
--help Show this message and exit. database
--nolock Ignore locking, open locked files in read-only
mode
--ssl-keyfile TEXT SSL key file
--ssl-certfile TEXT SSL certificate file
--help Show this message and exit.
.. [[[end]]] .. [[[end]]]
@ -566,8 +571,10 @@ This performance optimization is used automatically by some of the ``datasette p
Options: Options:
--inspect-file TEXT --inspect-file TEXT
--load-extension TEXT Path to a SQLite extension to load --load-extension PATH:ENTRYPOINT?
--help Show this message and exit. Path to a SQLite extension to load, and
optional entrypoint
--help Show this message and exit.
.. [[[end]]] .. [[[end]]]