Skip to content

Commit

Permalink
Merge pull request #6152 from sss-ng/docs/fix-missing-scripts
Browse files Browse the repository at this point in the history
docs update for `scripts` section and other small changes
  • Loading branch information
matteius authored May 24, 2024
2 parents 3ac18c3 + fc8a793 commit e9e5adf
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
8 changes: 8 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@ Spawns a command installed into the virtualenv.
pipenv run [OPTIONS] COMMAND [ARGS]...
```

## scripts

Lists scripts in current environment config.

```bash
pipenv scripts [OPTIONS]
```

## shell

Spawns a shell within the virtualenv.
Expand Down
12 changes: 8 additions & 4 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,19 @@ The user can provide these additional parameters:

## run

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

## shell

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

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

## check

``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.
``$ 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.


## scripts
``$ pipenv scripts`` will list the scripts in the current environment config.

0 comments on commit e9e5adf

Please sign in to comment.