The easiest way to use Pipes is to use the interactive switcher.
Before you can use Pipes to activate a given project, the selected environment must have a project directory associated with it. To understand how Pipes links Project Directories with corresponding virtualenvs read the section on how to Set Project Directory.
The Interactive environment switcher accepts the following commands:
DOWN: Scrolls through the list
PAGE DOWN: Scrolls through the list in larger increments
ENTER: Selects and activates the environemnt
ESC: Exit Pipes
RIGHT: Cycles through the available information on each virtual environment
QUERY: Use any alphanumeric characters to filter the list
BACKSPACE: Delete last character from filter term
DEL: Clear filter
From the Command Line¶
You can activate an environment directly from the command line
pipes followed by a query term which is used
to select the desired environment:
$ pipes project1
This would cd into directory
and activate the corresponding Pipenv Shell.
If a query term (eg.
proj) matches more than one project,
the Interactive Switcher will launch with the list filtered by
the entered query term.
Use Pipes to see all detected Pipenv Environments.
$ pipes --list
--list flag can also be used with the
which shows additional information about the environments
such as the environment path, project directory (if available) and
the python version of the virtual environment.
$ pipes --list --verbose
PIPENV_HOME: /Users/user/.local/share/virtualenvs project1-LwEMcb8W * Environment: $PIPENV_HOME/project1-LwEMcb8W Binary: Python 3.5.5 Project Dir: ~/dev/project project2-R1v7_ynT * Environment: $PIPENV_HOME/project2-R1v7_ynT Binary: Python 3.4.8 Project Dir: ~/dev/project2
The presence of an asterisk (
*) on the environment list
indicates if the virtual environment already has a project directory associated.
The lack of a
* indicates the Environment has not yet been
associated with a project directory. If you try switching into an
environment without the
*, Pipes will tell you need to
link the environment with a project directory first.
Use Pipes to delete a Pipenv Environment.
$ pipes project1 --delete
Environment 'project1-LwEMcb8W' deleted
Set Project Directory¶
To link a project directory with its environment use the
$ pipes --link /path/to/project1
Pipes will find the associated Pipenv Environmnet by
pipenv --venv from from the target directory.
If the target directory finds a valid environment, Pipes will
create a new
.project with the project path and save it inside
the virtual environment. This file is used by Pipes to detect the project
You can see the list of available commands directly from the command line:
$ pipes --help