Skip to content

Commit

Permalink
Add undocumented template variables to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lkubb committed Nov 8, 2024
1 parent 3647a06 commit a55f2c9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/creating.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ suitable to [autoupdate your project safely][the-copier-answersyml-file]:

Furthermore, the following keys are added:

#### `_copier_conf.os`

The detected Operating System, either `linux`, `macos`, `windows` or `None`.

#### `_copier_conf.sep`

The Operating System-specific directory separator.
Expand All @@ -113,6 +117,14 @@ The Operating System-specific directory separator.

The current commit hash from the template.

### `_copier_python`

The absolute path of the Python interpreter running Copier.

### `_folder_name`

The name of the project root directory.

## Variables (context-dependent)

Some variables are only available in select contexts:
Expand All @@ -122,3 +134,9 @@ Some variables are only available in select contexts:
The current operation, either `copy` or `update`.

Availability: [`exclude`](configuring.md#exclude), [`tasks`](configuring.md#tasks)

## Variables (context-specific)

Some rendering contexts provide variables unique to them:

- [`migrations`](configuring.md#migrations)

0 comments on commit a55f2c9

Please sign in to comment.