From 91494dcef7152d35909c3029e1b8c8dee5a4c384 Mon Sep 17 00:00:00 2001 From: Sam Snarr Date: Tue, 14 May 2024 20:49:30 -0400 Subject: [PATCH 1/2] docs update - added scripts section to commands and cli page - made commands page examples more consistent --- docs/cli.md | 8 ++++++++ docs/commands.md | 12 ++++++++---- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 8b48507ac9..c3f2a0f479 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -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. diff --git a/docs/commands.md b/docs/commands.md index cd1ee676e2..eb8bda4f15 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -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. \ No newline at end of file From fc8a79388d0d1e45df6260bcf6dd59b1c95fba89 Mon Sep 17 00:00:00 2001 From: Sam Snarr Date: Wed, 15 May 2024 19:16:31 -0400 Subject: [PATCH 2/2] added missing newline --- docs/commands.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/commands.md b/docs/commands.md index eb8bda4f15..a01b09bf29 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -83,4 +83,4 @@ The user can provide these additional parameters: ## scripts -``$ pipenv scripts`` will list the scripts in the current environment config. \ No newline at end of file +``$ pipenv scripts`` will list the scripts in the current environment config.