{
    "content": [
        {
            "type": "text",
            "text": "# virtualenv(1) (man)\n\n## NAME\n\nvirtualenv - Python virtual environment creator\n\n## SYNOPSIS\n\nvirtualenv  [--version] [--with-traceback] [-v | -q] [--app-data APPDATA] [--clear-app-data]\n[--discovery  {builtin}]  [-p   py]   [--creator   {builtin,cpython3-posix,venv}]   [--seeder\n{app-data,pip}]  [--no-seed] [--activators commaseplist] [--clear] [--system-site-packages]\n[--symlinks | --copies] [--no-download | --download] [--extra-search-dir d  [d  ...]]  [--pip\nversion]  [--setuptools  version] [--wheel version] [--no-pip] [--no-setuptools] [--no-wheel]\n[--symlink-app-data] [--prompt prompt] [-h] dest\n\n## DESCRIPTION\n\nThe virtualenv utility creates virtual Python instances, each invokable  with its own  Python\nexecutable.   Each instance can have different sets of modules, installable via easyinstall.\nVirtual Python instances can  also be created without root access.\n\n## TLDR\n\n> Create virtual isolated Python environments.\n\n- Create a new environment:\n  `virtualenv {{path/to/venv}}`\n- Customize the prompt prefix:\n  `virtualenv --prompt {{prompt_prefix}} {{path/to/venv}}`\n- Use a different version of Python with virtualenv:\n  `virtualenv {{-p|--python}} {{path/to/pythonbin}} {{path/to/venv}}`\n- Start (select) the environment:\n  `source {{path/to/venv}}/bin/activate`\n- Stop the environment:\n  `deactivate`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION** (21 subsections)\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "virtualenv",
        "section": "1",
        "mode": "man",
        "summary": "virtualenv - Python virtual environment creator",
        "synopsis": "virtualenv  [--version] [--with-traceback] [-v | -q] [--app-data APPDATA] [--clear-app-data]\n[--discovery  {builtin}]  [-p   py]   [--creator   {builtin,cpython3-posix,venv}]   [--seeder\n{app-data,pip}]  [--no-seed] [--activators commaseplist] [--clear] [--system-site-packages]\n[--symlinks | --copies] [--no-download | --download] [--extra-search-dir d  [d  ...]]  [--pip\nversion]  [--setuptools  version] [--wheel version] [--no-pip] [--no-setuptools] [--no-wheel]\n[--symlink-app-data] [--prompt prompt] [-h] dest",
        "tldr_summary": "Create virtual isolated Python environments.",
        "tldr_examples": [
            {
                "description": "Create a new environment",
                "command": "virtualenv {{path/to/venv}}"
            },
            {
                "description": "Customize the prompt prefix",
                "command": "virtualenv --prompt {{prompt_prefix}} {{path/to/venv}}"
            },
            {
                "description": "Use a different version of Python with virtualenv",
                "command": "virtualenv {{-p|--python}} {{path/to/pythonbin}} {{path/to/venv}}"
            },
            {
                "description": "Start (select) the environment",
                "command": "source {{path/to/venv}}/bin/activate"
            },
            {
                "description": "Stop the environment",
                "command": "deactivate"
            }
        ],
        "tldr_source": "official",
        "flags": [
            {
                "flag": "",
                "long": "--version",
                "arg": null,
                "description": "display the version of the virtualenv package and it's location, then exit"
            },
            {
                "flag": "",
                "long": "--with-traceback",
                "arg": null,
                "description": "on failure also display the stacktrace internals of virtualenv (default: False) --app-data APPDATA a data folder used as cache by the virtualenv (default: <temp folder>)"
            },
            {
                "flag": "",
                "long": "--clear-app-data",
                "arg": null,
                "description": "start with empty app data folder (default: False)"
            },
            {
                "flag": "-h",
                "long": "--help",
                "arg": null,
                "description": "show this help message and exit"
            },
            {
                "flag": "-v",
                "long": "--verbose",
                "arg": null,
                "description": "increase verbosity (default: 2)"
            },
            {
                "flag": "-q",
                "long": "--quiet",
                "arg": null,
                "description": "decrease verbosity (default: 0)"
            },
            {
                "flag": "-p",
                "long": "--python",
                "arg": null,
                "description": "target interpreter for which to create a virtual (either absolute path or identifier string) (default: /usr/bin/python3)"
            },
            {
                "flag": "",
                "long": "--clear",
                "arg": null,
                "description": "remove the destination directory if exist before starting (will overwrite files other‐ wise) (default: False)"
            },
            {
                "flag": "",
                "long": "--system-site-packages",
                "arg": null,
                "description": "give the virtual environment access to the system site-packages dir (default: False)"
            },
            {
                "flag": "",
                "long": "--symlinks",
                "arg": null,
                "description": "try to use symlinks rather than copies, when symlinks are not the default for the platform (default: True) --copies, --always-copy try to use copies rather than symlinks, even when symlinks are the default for the platform (default: False)"
            },
            {
                "flag": "",
                "long": "--download",
                "arg": null,
                "description": "pass to enable download of the latest pip, setuptools, and wheel from PyPI (default: False) --no-download, --never-download pass to disable download of the latest pip, setuptools, and wheel from PyPI (default: True) --extra-search-dir d [d ...] a path containing wheels the seeder may also use beside bundled (can be set 1+ times) (default: []) --pip version pip version to install, bundle for bundled (default: latest) --setuptools version setuptools version to install, bundle for bundled (default: latest) --wheel version wheel version to install, bundle for bundled (default: latest)"
            },
            {
                "flag": "",
                "long": "--no-pip",
                "arg": null,
                "description": "do not install pip (default: False)"
            },
            {
                "flag": "",
                "long": "--no-setuptools",
                "arg": null,
                "description": "do not install setuptools (default: False)"
            },
            {
                "flag": "",
                "long": "--no-wheel",
                "arg": null,
                "description": "do not install wheel (default: False)"
            },
            {
                "flag": "",
                "long": "--symlink-app-data",
                "arg": null,
                "description": "symlink the python packages from the app-data folder (requires seed pip>=19.3) (de‐ fault: False)"
            }
        ],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 5,
                "subsections": [
                    {
                        "name": "optional arguments:",
                        "lines": 1
                    },
                    {
                        "name": "--version",
                        "lines": 2,
                        "long": "--version"
                    },
                    {
                        "name": "--with-traceback",
                        "lines": 5,
                        "long": "--with-traceback"
                    },
                    {
                        "name": "--clear-app-data",
                        "lines": 2,
                        "long": "--clear-app-data"
                    },
                    {
                        "name": "-h --help",
                        "lines": 2,
                        "flag": "-h",
                        "long": "--help"
                    },
                    {
                        "name": "verbosity:",
                        "lines": 3
                    },
                    {
                        "name": "-v --verbose",
                        "lines": 2,
                        "flag": "-v",
                        "long": "--verbose"
                    },
                    {
                        "name": "-q --quiet",
                        "lines": 2,
                        "flag": "-q",
                        "long": "--quiet"
                    },
                    {
                        "name": "discovery:",
                        "lines": 5
                    },
                    {
                        "name": "-p --python",
                        "lines": 3,
                        "flag": "-p",
                        "long": "--python"
                    },
                    {
                        "name": "creator:",
                        "lines": 7
                    },
                    {
                        "name": "--clear",
                        "lines": 3,
                        "long": "--clear"
                    },
                    {
                        "name": "--system-site-packages",
                        "lines": 2,
                        "long": "--system-site-packages"
                    },
                    {
                        "name": "--symlinks",
                        "lines": 7,
                        "long": "--symlinks"
                    },
                    {
                        "name": "seeder:",
                        "lines": 8
                    },
                    {
                        "name": "--download",
                        "lines": 20,
                        "long": "--download"
                    },
                    {
                        "name": "--no-pip",
                        "lines": 2,
                        "long": "--no-pip"
                    },
                    {
                        "name": "--no-setuptools",
                        "lines": 2,
                        "long": "--no-setuptools"
                    },
                    {
                        "name": "--no-wheel",
                        "lines": 2,
                        "long": "--no-wheel"
                    },
                    {
                        "name": "--symlink-app-data",
                        "lines": 3,
                        "long": "--symlink-app-data"
                    },
                    {
                        "name": "activators:",
                        "lines": 12
                    }
                ]
            },
            {
                "name": "AUTHORS",
                "lines": 6,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "virtualenv - Python virtual environment creator\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "virtualenv  [--version] [--with-traceback] [-v | -q] [--app-data APPDATA] [--clear-app-data]\n[--discovery  {builtin}]  [-p   py]   [--creator   {builtin,cpython3-posix,venv}]   [--seeder\n{app-data,pip}]  [--no-seed] [--activators commaseplist] [--clear] [--system-site-packages]\n[--symlinks | --copies] [--no-download | --download] [--extra-search-dir d  [d  ...]]  [--pip\nversion]  [--setuptools  version] [--wheel version] [--no-pip] [--no-setuptools] [--no-wheel]\n[--symlink-app-data] [--prompt prompt] [-h] dest\n\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "The virtualenv utility creates virtual Python instances, each invokable  with its own  Python\nexecutable.   Each instance can have different sets of modules, installable via easyinstall.\nVirtual Python instances can  also be created without root access.\n\n",
                "subsections": [
                    {
                        "name": "optional arguments:",
                        "content": ""
                    },
                    {
                        "name": "--version",
                        "content": "display the version of the virtualenv package and it's location, then exit\n",
                        "long": "--version"
                    },
                    {
                        "name": "--with-traceback",
                        "content": "on failure also display the stacktrace internals of virtualenv (default: False)\n\n--app-data APPDATA\na data folder used as cache by the virtualenv (default: <temp folder>)\n",
                        "long": "--with-traceback"
                    },
                    {
                        "name": "--clear-app-data",
                        "content": "start with empty app data folder (default: False)\n",
                        "long": "--clear-app-data"
                    },
                    {
                        "name": "-h --help",
                        "content": "show this help message and exit\n",
                        "flag": "-h",
                        "long": "--help"
                    },
                    {
                        "name": "verbosity:",
                        "content": "verbosity = verbose - quiet, default INFO, mapping => CRITICAL=0, ERROR=1,  WARNING=2,\nINFO=3, DEBUG=4, NOTSET=5\n"
                    },
                    {
                        "name": "-v --verbose",
                        "content": "increase verbosity (default: 2)\n",
                        "flag": "-v",
                        "long": "--verbose"
                    },
                    {
                        "name": "-q --quiet",
                        "content": "decrease verbosity (default: 0)\n",
                        "flag": "-q",
                        "long": "--quiet"
                    },
                    {
                        "name": "discovery:",
                        "content": "discover and provide a target interpreter\n\n--discovery {builtin}\ninterpreter discovery method (default: builtin)\n"
                    },
                    {
                        "name": "-p --python",
                        "content": "target  interpreter  for which to create a virtual (either absolute path or identifier\nstring) (default: /usr/bin/python3)\n",
                        "flag": "-p",
                        "long": "--python"
                    },
                    {
                        "name": "creator:",
                        "content": "options for creator builtin\n\n--creator {builtin,cpython3-posix,venv}\ncreate environment via (builtin = cpython3-posix) (default: builtin)\n\ndest   directory to create virtualenv at\n"
                    },
                    {
                        "name": "--clear",
                        "content": "remove the destination directory if exist before starting (will overwrite files other‐\nwise) (default: False)\n",
                        "long": "--clear"
                    },
                    {
                        "name": "--system-site-packages",
                        "content": "give the virtual environment access to the system site-packages dir (default: False)\n",
                        "long": "--system-site-packages"
                    },
                    {
                        "name": "--symlinks",
                        "content": "try  to  use  symlinks  rather  than copies, when symlinks are not the default for the\nplatform (default: True)\n\n--copies, --always-copy\ntry to use copies rather than symlinks, even when symlinks are  the  default  for  the\nplatform (default: False)\n",
                        "long": "--symlinks"
                    },
                    {
                        "name": "seeder:",
                        "content": "options for seeder app-data\n\n--seeder {app-data,pip}\nseed packages install method (default: app-data)\n\n--no-seed, --without-pip\ndo not install seed packages (default: False)\n"
                    },
                    {
                        "name": "--download",
                        "content": "pass  to  enable download of the latest pip, setuptools, and wheel from PyPI (default:\nFalse)\n\n--no-download, --never-download\npass to disable download of the latest pip, setuptools, and wheel from PyPI  (default:\nTrue)\n\n--extra-search-dir d [d ...]\na  path containing wheels the seeder may also use beside bundled (can be set 1+ times)\n(default: [])\n\n--pip version\npip version to install, bundle for bundled (default: latest)\n\n--setuptools version\nsetuptools version to install, bundle for bundled (default: latest)\n\n--wheel version\nwheel version to install, bundle for bundled (default: latest)\n",
                        "long": "--download"
                    },
                    {
                        "name": "--no-pip",
                        "content": "do not install pip (default: False)\n",
                        "long": "--no-pip"
                    },
                    {
                        "name": "--no-setuptools",
                        "content": "do not install setuptools (default: False)\n",
                        "long": "--no-setuptools"
                    },
                    {
                        "name": "--no-wheel",
                        "content": "do not install wheel (default: False)\n",
                        "long": "--no-wheel"
                    },
                    {
                        "name": "--symlink-app-data",
                        "content": "symlink the python packages from the app-data folder (requires  seed  pip>=19.3)  (de‐\nfault: False)\n",
                        "long": "--symlink-app-data"
                    },
                    {
                        "name": "activators:",
                        "content": "options for activation scripts\n\n--activators commaseplist\nactivators  to  generate  - default is all supported (default: bash,cshell,fish,power‐\nshell,python,xonsh)\n\n--prompt prompt\nprovides an alternative prompt prefix for this environment (default: None)\n\nconfig file  $HOME/.config/virtualenv/virtualenv.ini  (change  via  env  var  VIRTUALENVCON‐\nFIGFILE)\n"
                    }
                ]
            },
            "AUTHORS": {
                "content": "This  man-page  was created using help2man and then updated by Scott Kitterman <scott@kitter‐\nman.com> and is licensed under the same terms as virtualenv.\n\n\n\nVIRTUALENV(1)",
                "subsections": []
            }
        }
    }
}