Skip to content

Commit e9e5adf

Browse files
authored
Merge pull request #6152 from sss-ng/docs/fix-missing-scripts
docs update for `scripts` section and other small changes
2 parents 3ac18c3 + fc8a793 commit e9e5adf

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/cli.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@ Spawns a command installed into the virtualenv.
8282
pipenv run [OPTIONS] COMMAND [ARGS]...
8383
```
8484

85+
## scripts
86+
87+
Lists scripts in current environment config.
88+
89+
```bash
90+
pipenv scripts [OPTIONS]
91+
```
92+
8593
## shell
8694

8795
Spawns a shell within the virtualenv.

docs/commands.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,19 @@ The user can provide these additional parameters:
6868

6969
## run
7070

71-
``run`` will run a given command from the virtualenv, with any arguments forwarded (e.g. ``$ pipenv run python`` or ``$ pipenv run pip freeze``).
71+
``$ pipenv run`` will run a given command from the virtualenv, with any arguments forwarded (e.g. ``$ pipenv run python`` or ``$ pipenv run pip freeze``).
7272

7373
## shell
7474

75-
``shell`` will spawn a shell with the virtualenv activated. This shell can be deactivated by using ``exit``.
75+
``$ pipenv shell`` will spawn a shell with the virtualenv activated. This shell can be deactivated by using ``exit``.
7676

7777
## graph
78-
``graph`` will show you a dependency graph of your installed dependencies where each root node is a specifier from the ``Pipfile``.
78+
``$ pipenv graph`` will show you a dependency graph of your installed dependencies where each root node is a specifier from the ``Pipfile``.
7979

8080
## check
8181

82-
``check`` checks for security vulnerabilities and asserts that [PEP 508](https://www.python.org/dev/peps/pep-0508/) requirements are being met by the project's lock file or current environment.
82+
``$ pipenv check`` checks for security vulnerabilities and asserts that [PEP 508](https://www.python.org/dev/peps/pep-0508/) requirements are being met by the project's lock file or current environment.
83+
84+
85+
## scripts
86+
``$ pipenv scripts`` will list the scripts in the current environment config.

0 commit comments

Comments
 (0)