CLI Reference
cosmofy
A Cosmopolitan Python bundler.
Usage: cosmofy [OPTIONS] <COMMAND>
Commands:
bundle build and bundle a project
updater install/uninstall bundle self-updater
fs inspect and modify an existing bundle
self manage the `cosmofy` executable
completions generate shell completions
Options:
--version display the program version and exit
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy bundle
Build a Python project into a Cosmopolitan bundle.
Usage: cosmofy bundle [OPTIONS]
Input options:
--entry <NAME> `console_script` entry points to bundle
--script <PATH> paths to bundle
If neither --entry nor --script is specified, all entry points
will be bundled. If both are specified, entries will be bundled first.
--python-url <URL> URL from which to download Cosmopolitan Python
[default: https://cosmo.zip/pub/cosmos/bin/python]
[env: COSMOFY_PYTHON_URL=]
Output options:
-o, --output-dir <PATH> output directory
[default: project-root/dist]
-s, --suffix <SUFFIX> file extension for output executables
[default: '.com' on Windows, '' otherwise]
-c, --compile-bytecode compile .py files to .pyc using Cosmopolitan Python
Cache options:
-n, --no-cache do not read or save to the cache
[env: COSMOFY_NO_CACHE=]
--cache-dir <PATH> store Cosmopolitan Python downloads
[default: ~/.cache/cosmofy]
[env: COSMOFY_CACHE_DIR=]
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy updater
EXPERIMENTAL: Manage a bundle's self-updater.
Usage: cosmofy updater [OPTIONS] <COMMAND>
Commands:
add add self-updater to a bundle
remove remove self-updater from a bundle
check check if the bundle has updates
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy updater add
EXPERIMENTAL: Add self-updater to a cosmofy bundle.
Usage: cosmofy updater add <BUNDLE> [OPTIONS]
Arguments:
<BUNDLE> Cosmopolitan file bundle
Receipt options:
--receipt <PATH> output path to the JSON receipt
default is <BUNDLE> + `.json`
--receipt-url <URL> URL to the published receipt
default is --release-url + `.json`
[env: RECEIPT_URL=]
--release-url <URL> URL to the file to download
default is --receipt-url without `.json`
[env: RELEASE_URL=]
--release-version <STRING>
release version
default is $(<BUNDLE> --version)
Process options:
--no-copy skip copying `cosmofy` code
(e.g., its already a dependency)
[env: COSMOFY_NO_COPY=]
--no-args skip setting `.args`
[env: COSMOFY_NO_ARGS=]
read more: https://github.com/metaist/cosmofy#self-updater
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy updater remove
EXPERIMENTAL: Remove cosmofy self-updater from a cosmofy bundle.
Usage: cosmofy updater remove <BUNDLE> [OPTIONS]
Arguments:
<BUNDLE> Cosmopolitan file bundle
Process options:
--no-args skip setting `.args`
[env: COSMOFY_NO_ARGS=]
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy updater check
EXPERIMENTAL: Check if a cosmofy bundle has an update.
Usage: cosmofy updater check <BUNDLE> [OPTIONS]
Arguments:
<BUNDLE> Cosmopolitan file bundle
Options:
--receipt-url <URL> override the published receipt URL
[env: RECEIPT_URL=]
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy fs
Cosmopolitan file system tool.
Usage: cosmofy fs [OPTIONS] <COMMAND>
Commands:
ls list files in bundle
cat print file contents
add add files to bundle
rm remove files from bundle
args get/set special `.args` file in bundle
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy fs ls
List contents of a Cosmopolitan bundle.
Usage: cosmofy fs ls <BUNDLE> [OPTIONS] [FILE]...
Arguments:
<BUNDLE> Cosmopolitan file bundle
[FILE]... one or more file patterns to show
Filter options:
-a, --all show entries whose name starts with `.`
-B, --ignore-backups hide entries whose name ends with `~`
--hide <PATTERN> hide matching entries, unless --all
-I, --ignore <PATTERN> hide matching entries, even with --all
Sort options:
-r, --reverse reverse the sort order
--sort <MODE> [choices: none, name, size, time, extension]
[default: name]
Output options:
-l, --long show permissions, size, and modified date
-h, --human-readable show sizes using powers of 1024 like 1K 2M 3G etc.
--si show sizes using powers of 1000 (implies -h)
Global options:
--help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy fs cat
Print contents of a file within a Cosmopolitan bundle.
Usage: cosmofy fs cat <BUNDLE> <FILE>... [OPTIONS]
Arguments:
<BUNDLE> Cosmopolitan file bundle
<FILE>... one or more file patterns to show
tip: Use `--` to separate options from filenames that start with `-`
Example: cosmofy fs cat bundle.zip -- -weird-filename.txt
Options:
-p, --prompt prompt for a decryption password
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy fs add
Add files to a Cosmopolitan bundle.
Usage: cosmofy fs add <BUNDLE> [OPTIONS] <FILE>...
Arguments:
<BUNDLE> Cosmopolitan file bundle
<FILE>... files relative to current directory to add
tip: Use `--` to separate options from filenames that start with `-`
Example: cosmofy fs add bundle.zip -- -weird-filename.txt
Options:
-f, --force overwrite existing files
--chdir <PATH> change to this directory before adding
--dest prefix to add in the bundle
Most python packages go into `Lib/site-packages`
-c, --compile-bytecode compile .py files to .pyc using the bundle's Python
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy fs rm
Remove files from a Cosmopolitan bundle.
Usage: cosmofy fs rm <BUNDLE> [OPTIONS] <FILE>...
Arguments:
<BUNDLE> Cosmopolitan file bundle
<FILE>... files to remove
tip: Use `--` to separate options from filenames that start with `-`
Example: cosmofy fs rm bundle.zip -- -weird-filename.txt
Options:
-f, --force ignore nonexistent files
-r, --recursive recursively remove directories
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy fs args
Get or set the special `.args` files in a Cosmopolitan bundle.
These are the arguments to the Cosmopolitan Python.
Usage: cosmofy fs args <BUNDLE> [OPTIONS] [VAL]
Arguments:
<BUNDLE> Cosmopolitan file bundle
[VAL] value to set (if omitted, current value is printed)
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy self
Manage the `cosmofy` executable.
Usage: cosmofy self [OPTIONS] <COMMAND>
Commands:
update update `cosmofy`
version display `cosmofy`'s version
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy self update
Update `cosmofy`.
Usage: cosmofy self update [OPTIONS]
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]
cosmofy self version
Display `cosmofy`'s version.
Usage: cosmofy self version [OPTIONS]
Options:
--short only print the version
Global options:
-h, --help show this help message
-q, --quiet... show quiet output
-v, --verbose... show verbose output
--dry-run do not make any filesystem changes
--color <COLOR> control output color
[default: auto][choices: auto, always, never]
(auto checks `NO_COLOR`, `FORCE_COLOR`, `CLICOLOR`,
`CLICOLOR_FORCE` and tty support)
--output-format NAME output format
[default: text][choices: text, json]