lix/src/nix/flake-init.md

63 lines
1.2 KiB
Markdown
Raw Normal View History

2020-12-23 12:19:53 +00:00
R""(
# Examples
* Create a flake using the default template:
```console
# nix flake init
```
* List available templates:
```console
# nix flake show templates
```
* Create a flake from a specific template:
```console
# nix flake init -t templates#simpleContainer
```
# Description
This command creates a flake in the current directory by copying the
files of a template. It will not overwrite existing files. The default
2021-03-26 15:14:38 +00:00
template is `templates#defaultTemplate`, but this can be overridden
2020-12-23 12:19:53 +00:00
using `-t`.
# Template definitions
A flake can declare templates through its `templates` and
`defaultTemplate` output attributes. A template has two attributes:
* `description`: A one-line description of the template, in CommonMark
syntax.
* `path`: The path of the directory to be copied.
* `welcomeText`: A block of text to display when a user initializes a new flake
based on this template.
2020-12-23 12:19:53 +00:00
Here is an example:
```
outputs = { self }: {
templates.rust = {
path = ./rust;
description = "A simple Rust/Cargo project";
welcomeText = ''
You've created a simple Rust/Cargo template.
Visit https://www.rust-lang.org/ for more info.
'';
2020-12-23 12:19:53 +00:00
};
templates.defaultTemplate = self.templates.rust;
}
```
)""