Skip to content

Commit fefdd6c

Browse files
docs: add environment variables inline
1 parent 8e8aa44 commit fefdd6c

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

docs/configuration.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,8 @@ You can override the Cache directory by setting the `POETRY_CACHE_DIR` environme
149149

150150
**Type**: `string`
151151

152+
**Environment Variable**: `POETRY_CACHE_DIR`
153+
152154
The path to the cache directory used by Poetry.
153155

154156
Defaults to one of the following directories:
@@ -163,6 +165,8 @@ Defaults to one of the following directories:
163165

164166
**Default**: `false`
165167

168+
**Environment Variable**: `POETRY_EXPERIMENTAL_SYSTEM_GIT_CLIENT`
169+
166170
*Introduced in 1.2.0*
167171

168172
Use system git client backend for git related tasks.
@@ -177,6 +181,8 @@ If you encounter any problems with it, set to `true` to use the system git backe
177181

178182
**Default**: `number_of_cores + 4`
179183

184+
**Environment Variable**: `POETRY_INSTALLER_MAX_WORKERS`
185+
180186
*Introduced in 1.2.0*
181187

182188
Set the maximum number of workers while using the parallel installer.
@@ -196,6 +202,8 @@ This configuration is ignored when `installer.parallel` is set to `false`.
196202

197203
**Default**: `false`
198204

205+
**Environment Variable**: `POETRY_INSTALLER_NO_BINARY`
206+
199207
*Introduced in 1.2.0*
200208

201209
When set this configuration allows users to configure package distribution format policy for all or
@@ -245,6 +253,8 @@ across all your projects if incorrectly set.
245253

246254
**Default**: `true`
247255

256+
**Environment Variable**: `POETRY_INSTALLER_PARALLEL`
257+
248258
*Introduced in 1.1.4*
249259

250260
Use parallel execution when using the new (`>=1.1.0`) installer.
@@ -255,6 +265,8 @@ Use parallel execution when using the new (`>=1.1.0`) installer.
255265

256266
**Default**: `true`
257267

268+
**Environment Variable**: `POETRY_VIRTUALENVS_CREATE`
269+
258270
Create a new virtual environment if one doesn't already exist.
259271

260272
If set to `false`, Poetry will not create a new virtual environment. If it detects a virtual environment
@@ -281,6 +293,8 @@ might contain additional Python packages as well.
281293

282294
**Default**: `None`
283295

296+
**Environment Variable**: `POETRY_VIRTUALENVS_IN_PROJECT`
297+
284298
Create the virtualenv inside the project's root directory.
285299

286300
If not set explicitly, `poetry` by default will create virtual environment under
@@ -297,6 +311,8 @@ If set to `false`, `poetry` will ignore any existing `.venv` directory.
297311

298312
**Default**: `false`
299313

314+
**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_ALWAYS_COPY`
315+
300316
*Introduced in 1.2.0*
301317

302318
If set to `true` the `--always-copy` parameter is passed to `virtualenv` on creation of the virtual environment, so that
@@ -308,6 +324,8 @@ all needed files are copied into it instead of symlinked.
308324

309325
**Default**: `false`
310326

327+
**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_NO_PIP`
328+
311329
*Introduced in 1.2.0*
312330

313331
If set to `true` the `--no-pip` parameter is passed to `virtualenv` on creation of the virtual environment. This means
@@ -328,6 +346,8 @@ packages. This is desirable for production environments.
328346

329347
**Default**: `false`
330348

349+
**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_NO_SETUPTOOLS`
350+
331351
*Introduced in 1.2.0*
332352

333353
If set to `true` the `--no-setuptools` parameter is passed to `virtualenv` on creation of the virtual environment. This
@@ -345,6 +365,8 @@ available within a virtual environment. This can cause some features in these to
345365

346366
**Default**: `false`
347367

368+
**Environment Variable**: `POETRY_VIRTUALENVS_OPTIONS_SYSTEM_SITE_PACKAGES`
369+
348370
Give the virtual environment access to the system site-packages directory.
349371
Applies on virtualenv creation.
350372

@@ -354,6 +376,8 @@ Applies on virtualenv creation.
354376

355377
**Default**: `{cache-dir}/virtualenvs`
356378

379+
**Environment Variable**: `POETRY_VIRTUALENVS_PATH`
380+
357381
Directory where virtual environments will be created.
358382

359383
### `virtualenvs.prefer-active-python` (experimental)
@@ -362,6 +386,8 @@ Directory where virtual environments will be created.
362386

363387
**Default**: `false`
364388

389+
**Environment Variable**: `POETRY_VIRTUALENVS_PREFER_ACTIVE_PYTHON`
390+
365391
*Introduced in 1.2.0*
366392

367393
Use currently activated Python version to create a new virtual environment.
@@ -373,6 +399,8 @@ If set to `false`, Python version used during Poetry installation is used.
373399

374400
**Default**: `{project_name}-py{python_version}`
375401

402+
**Environment Variable**: `POETRY_VIRTUALENVS_PROMPT`
403+
376404
*Introduced in 1.2.0*
377405

378406
Format string defining the prompt to be displayed when the virtual environment is activated.
@@ -382,12 +410,16 @@ The variables `project_name` and `python_version` are available for formatting.
382410

383411
**Type**: `string`
384412

413+
**Environment Variable**: `POETRY_REPOSITORIES_<NAME>`
414+
385415
Set a new alternative repository. See [Repositories]({{< relref "repositories" >}}) for more information.
386416

387417
### `http-basic.<name>`:
388418

389419
**Type**: `(string, string)`
390420

421+
**Environment Variable**: `POETRY_HTTP_BASIC_<NAME>`
422+
391423
Set repository credentials (`username` and `password`) for `<name>`.
392424
See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}})
393425
for more information.
@@ -396,6 +428,8 @@ for more information.
396428

397429
**Type**: `string`
398430

431+
**Environment Variable**: `POETRY_PYPI_TOKEN_<NAME>`
432+
399433
Set repository credentials (using an API token) for `<name>`.
400434
See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}})
401435
for more information.
@@ -404,6 +438,8 @@ for more information.
404438

405439
**Type**: `string | boolean`
406440

441+
**Environment Variable**: `POETRY_CERTIFICATES_<NAME>_CERT`
442+
407443
Set custom certificate authority for repository `<name>`.
408444
See [Repositories - Configuring credentials - Custom certificate authority]({{< relref "repositories#custom-certificate-authority-and-mutual-tls-authentication" >}})
409445
for more information.
@@ -415,6 +451,8 @@ repository.
415451

416452
**Type**: `string`
417453

454+
**Environment Variable**: `POETRY_CERTIFICATES_<NAME>_CLIENT_CERT`
455+
418456
Set client certificate for repository `<name>`.
419457
See [Repositories - Configuring credentials - Custom certificate authority]({{< relref "repositories#custom-certificate-authority-and-mutual-tls-authentication" >}})
420458
for more information.

0 commit comments

Comments
 (0)