From 6897ebffa31a025407b2e04658873de6b2229559 Mon Sep 17 00:00:00 2001 From: Glen Smith Date: Tue, 8 Sep 2020 08:41:48 -0600 Subject: [PATCH] Add documentation of new `scripts` command. --- README.md | 2 ++ docs/advanced.rst | 9 +++++++++ news/3686.feature.rst | 2 ++ 3 files changed, 13 insertions(+) create mode 100644 news/3686.feature.rst diff --git a/README.md b/README.md index 9b7ff6d0..ef08a525 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,8 @@ Fish is the best shell. You should use it. lock Generates Pipfile.lock. open View a given module in your editor. run Spawns a command installed into the virtualenv. + scripts Displays the shortcuts in the (optional) [scripts] section of + Pipfile. shell Spawns a shell within the virtualenv. sync Installs all packages specified in Pipfile.lock. uninstall Un-installs a provided package and removes it from Pipfile. diff --git a/docs/advanced.rst b/docs/advanced.rst index b2944da9..d8aff57a 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -428,6 +428,15 @@ For example: $ pipenv run echospam "indeed" I am really a very silly example indeed +You can then display the names and commands of your shortcuts by running ``pipenv scripts`` in your terminal. + +:: + + $ pipenv scripts + command script + echospam echo I am really a very silly example + + ☤ Support for Environment Variables ----------------------------------- diff --git a/news/3686.feature.rst b/news/3686.feature.rst new file mode 100644 index 00000000..101e369b --- /dev/null +++ b/news/3686.feature.rst @@ -0,0 +1,2 @@ +Add a new command ``pipenv scripts`` to display shortcuts from Pipfile. +