diff --git a/docs/cli.md b/docs/cli.md index d1765fc85ec..fe0219eb682 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -452,6 +452,7 @@ required by * `--tree`: List the dependencies as a tree. * `--latest (-l)`: Show the latest version. * `--outdated (-o)`: Show the latest version but only for packages that are outdated. +* `--all (-a)`: Show all packages (even those not compatible with current system). {{% note %}} When `--only` is specified, `--with` and `--without` options are ignored. @@ -490,6 +491,9 @@ It can also build the package if you pass it the `--build` option. Should match a repository name set by the [`config`](#config) command. * `--username (-u)`: The username to access the repository. * `--password (-p)`: The password to access the repository. +* `--cert`: Certificate authority to access the repository. +* `--client-cert`: Client certificate to access the repository. +* `--build`: Build the package before publishing. * `--dry-run`: Perform all actions except upload the package. * `--skip-existing`: Ignore errors from files already existing in the repository. @@ -552,7 +556,7 @@ If one doesn't exist yet, it will be created. poetry shell ``` -Note that this commmand starts a new shell and activates the virtual environment. +Note that this command starts a new shell and activates the virtual environment. As such, `exit` should be used to properly exit the shell and the virtual environment instead of `deactivate`. @@ -743,6 +747,10 @@ The `plugin remove` command removes installed plugins. poetry plugin remove poetry-plugin ``` +#### Options + +* `--dry-run`: Outputs the operations but will not execute anything (implicitly enables --verbose). + ## source The `source` namespace regroups sub commands to manage repository sources for a Poetry project. @@ -795,3 +803,45 @@ The `source remove` command removes a configured source from your `pyproject.tom ```bash poetry source remove pypi-test ``` + +## about + +The `about` command displays global information about Poetry, including the current version and version of `poetry-core`. + +```bash +poetry about +``` + +## help + +The `help` command displays global help, or help for a specific command. + +To display global help: + +```bash +poetry help +``` + +To display help for a specific command, for instance `show`: + +```bash +poetry help show +``` + +{{% note %}} +The `--help` option can also be passed to any command to get help for a specific command. + +For instance: + +```bash +poetry show --help +``` +{{% /note %}} + +## list + +The `list` command displays all the available Poetry commands. + +```bash +poetry list +``` diff --git a/docs/managing-environments.md b/docs/managing-environments.md index 751c53cf84b..145398c23f9 100644 --- a/docs/managing-environments.md +++ b/docs/managing-environments.md @@ -119,6 +119,12 @@ test-O3eWbxRl-py3.6 test-O3eWbxRl-py3.7 (Activated) ``` +You can pass the option `--full-path` to display the full path to the environments: + +```bash +poetry env list --full-path +``` + ## Deleting the environments Finally, you can delete existing virtual environments by using `env remove`: