added CLI section to docs

mbway · Feb 29, 2024 · 1d85ae6 · 1d85ae6
1 parent 2f9bd84
commit 1d85ae6
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/basics.md b/docs/basics.md
@@ -79,6 +79,15 @@ in every script, meaning the scripts do not need alteration before deployment.
 Installation into `sitecustomize.py` can be managed with the import hook cli using
 `python -m maturin_import_hook site install`. The CLI can also manage uninstallation.
 
+## CLI
+
+The package provides a CLI interface for getting information such as the location and size of the build cache and
+managing the installation into `sitecustomize.py`. For details, run:
+
+```shell
+python -m maturin_import_hook --help
+```
+
 ## Environment Variables
 
 The import hook can be disabled by setting `MATURIN_IMPORT_HOOK_ENABLED=0`. This can be used to disable