Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing documentation options and commands #5664

Merged
merged 5 commits into from
May 23, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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`.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 version and version of `poetry-core`.
mkniewallner marked this conversation as resolved.
Show resolved Hide resolved

```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
```
6 changes: 6 additions & 0 deletions docs/managing-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down