Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vf: add page #11219

Merged
merged 3 commits into from
Oct 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions pages/common/vf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# vf

> VirtualFish is a fish shell tool for managing Python virtual environments.
> More information: <https://virtualfish.readthedocs.io/en/latest/>.

- Create a virtual environment:

`vf new {{virtualenv_name}}`

- Create a virtual environment for a specific Python version:

`vf new --python {{/usr/local/bin/python3.8}} {{virtualenv_name}}`

- Activate and use the specified virtual environment:

`vf activate {{virtualenv_name}}`

- Connect the current virtualenv to the current directory, so that it is activated automatically as soon as you enter it (and deactivated as soon as you leave):

`vf connect`

- Deactivate the current virtual environment:

`vf deactivate`

- List all virtual environments:

`vf ls`

- Remove a virtual environment:

`vf rm {{virtualenv_name}}`

- Display help:

`vf help`