datasette/docs/datasette-package-help.txt

$ datasette package --help

Usage: datasette package [OPTIONS] FILES...

  Package specified SQLite files into a new datasette Docker container

Options:
  -t, --tag TEXT            Name for the resulting Docker container, can optionally use
                            name:tag format
  -m, --metadata FILENAME   Path to JSON/YAML file containing metadata to publish
  --extra-options TEXT      Extra options to pass to datasette serve
  --branch TEXT             Install datasette from a GitHub branch e.g. main
  --template-dir DIRECTORY  Path to directory containing custom templates
  --plugins-dir DIRECTORY   Path to directory containing custom plugins
  --static MOUNT:DIRECTORY  Serve static files from this directory at /MOUNT/...
  --install TEXT            Additional packages (e.g. plugins) to install
  --spatialite              Enable SpatialLite extension
  --version-note TEXT       Additional note to show on /-/versions
  --secret TEXT             Secret used for signing secure values, such as signed
                            cookies
  -p, --port INTEGER RANGE  Port to run the server on, defaults to 8001  [1<=x<=65535]
  --title TEXT              Title for metadata
  --license TEXT            License label for metadata
  --license_url TEXT        License URL for metadata
  --source TEXT             Source label for metadata
  --source_url TEXT         Source URL for metadata
  --about TEXT              About label for metadata
  --about_url TEXT          About URL for metadata
  --help                    Show this message and exit.
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336 2018-07-10 19:04:13 -07:00			`$ datasette package --help`

'Usage: datasette', not 'Usage: cli' - refs #336 2018-07-24 09:03:07 -07:00			`Usage: datasette package [OPTIONS] FILES...`
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336 2018-07-10 19:04:13 -07:00
			`Package specified SQLite files into a new datasette Docker container`

			`Options:`
Ensure --help examples in docs are always up to date, closes #336 Unit tests now check that docs/*.txt help examples are all up-to-date. I ran into a problem here in that the terminal_width needed to be more accurately defined - so I replaced update-docs-help.sh with update-docs- help.py which hard-codes the terminal width. 2018-07-24 09:00:10 -07:00			`-t, --tag TEXT Name for the resulting Docker container, can optionally use`
			`name:tag format`
--metadata accepts YAML as well as JSON - closes #713 2020-04-02 12:30:53 -07:00			`-m, --metadata FILENAME Path to JSON/YAML file containing metadata to publish`
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336 2018-07-10 19:04:13 -07:00			`--extra-options TEXT Extra options to pass to datasette serve`
Fixed master -> main in a bunch of places, mainly docs 2021-03-23 09:19:41 -07:00			`--branch TEXT Install datasette from a GitHub branch e.g. main`
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336 2018-07-10 19:04:13 -07:00			`--template-dir DIRECTORY Path to directory containing custom templates`
			`--plugins-dir DIRECTORY Path to directory containing custom plugins`
Better documentation for --static, closes #641 https://datasette.readthedocs.io/en/stable/custom_templates.html#serving-static-files 2019-11-25 18:31:42 -08:00			`--static MOUNT:DIRECTORY Serve static files from this directory at /MOUNT/...`
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336 2018-07-10 19:04:13 -07:00			`--install TEXT Additional packages (e.g. plugins) to install`
			`--spatialite Enable SpatialLite extension`
			`--version-note TEXT Additional note to show on /-/versions`
--secret command for datasette publish Closes #787 2020-06-11 09:02:03 -07:00			`--secret TEXT Secret used for signing secure values, such as signed`
			`cookies`
Updated --help output for latest Click, closes #1354 2021-06-01 09:16:58 -07:00			`-p, --port INTEGER RANGE Port to run the server on, defaults to 8001 [1<=x<=65535]`
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336 2018-07-10 19:04:13 -07:00			`--title TEXT Title for metadata`
			`--license TEXT License label for metadata`
			`--license_url TEXT License URL for metadata`
			`--source TEXT Source label for metadata`
			`--source_url TEXT Source URL for metadata`
about and about_url metadata options 2019-03-10 14:37:11 -07:00			`--about TEXT About label for metadata`
			`--about_url TEXT About URL for metadata`
Docs for datasette publish and package, closes #337 Also introduced a new mechanism for ensuring the --help examples in the documentation reflect the current output of the --help commands, via a new update-docs-help.sh script. Closes #336 2018-07-10 19:04:13 -07:00			`--help Show this message and exit.`