1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
|
# Pipenv CLI Reference
## pipenv
```bash
pipenv [OPTIONS] COMMAND [ARGS]...
```
## check
Checks for PyUp Safety security vulnerabilities and against PEP 508 markers provided in Pipfile.
```bash
pipenv check [OPTIONS]
```
## clean
Uninstalls all packages not specified in Pipfile.lock.
```bash
pipenv clean [OPTIONS]
```
## graph
Displays currently–installed dependency graph information.
```bash
pipenv graph [OPTIONS]
```
## install
Installs provided packages and adds them to Pipfile, or (if no packages are given), installs all packages from Pipfile.lock
```bash
pipenv install [OPTIONS] [PACKAGES]...
```
Environment Variables
PIP_INDEX_URL
```bash
Provide a default for -i
```
## lock
Generates Pipfile.lock.
```bash
pipenv lock [OPTIONS]
```
## open
View a given module in your editor.
This uses the EDITOR environment variable. You can temporarily override it, for example:
EDITOR=atom pipenv open requests
```bash
pipenv open [OPTIONS] MODULE
```
## requirements
Generate a requirements.txt from Pipfile.lock.
```bash
pipenv requirements [OPTIONS]
```
## run
Spawns a command installed into the virtualenv.
```bash
pipenv run [OPTIONS] COMMAND [ARGS]...
```
## scripts
Lists scripts in current environment config.
```bash
pipenv scripts [OPTIONS]
```
## shell
Spawns a shell within the virtualenv.
```bash
pipenv shell [OPTIONS] [SHELL_ARGS]...
```
## sync
Installs all packages specified in Pipfile.lock.
```bash
pipenv sync [OPTIONS]
```
## uninstall
Un-installs a provided package and removes it from Pipfile.
```bash
pipenv uninstall [OPTIONS] [PACKAGES]...
```
## update
Runs lock when no packages are specified, or upgrade, and then sync.
```bash
pipenv update [OPTIONS] [PACKAGES]...
```
Environment Variables
PIP_INDEX_URL
```bash
Provide a default for -i
```
## upgrade
Resolves provided packages and adds them to Pipfile, or (if no packages are given), merges results to Pipfile.lock
```bash
pipenv upgrade [OPTIONS] [PACKAGES]...
```
Environment Variables
PIP_INDEX_URL
```bash
Provide a default for -i
```
## verify
Verify the hash in Pipfile.lock is up-to-date.
```bash
pipenv verify [OPTIONS]
```
|