Skip to content

Commit

Permalink
doc(cli): add missing docs for env command
Browse files Browse the repository at this point in the history
  • Loading branch information
abn committed Jan 13, 2025
1 parent bd500dd commit b47d938
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -890,6 +890,52 @@ associated with a specific project.

See [Managing environments]({{< relref "managing-environments" >}}) for more information about these commands.

### activate

The `env activate` command prints the command to activate a virtual environment in our current shell.

{{% note %}}
This command does not activate the virtual environment, but only displays the activation command, for more information
on how to use this command see [here]({{< relref "managing-environments#activating-the-environment" >}}).
{{% /note %}}

### info

The `env info` command displays information about the current environment.

#### Options

* `--path (-p)`: Only display the environment's path.
* `--executable (-e)`: Only display the environment's python executable path.

### list

The `env list` command lists all virtualenvs associated with the current project.

#### Options

* `--full-path`: Output the full paths of the virtualenvs.

### remove

The `env remove` command removes virtual environments associated with the project.

#### Arguments

* `python`: The python executables associated with, or names of the virtual environments which are to be removed.

#### Options

* `--all`: Remove all managed virtual environments associated with the project.

### use

The `env use` command activates or creates a new a virtualenv for the current project.

#### Arguments

* `python`: The python executable to use.

## cache

The `cache` command regroups sub commands to interact with Poetry's cache.
Expand Down

0 comments on commit b47d938

Please sign in to comment.