NixOS Wiki

Flakes/ja: Difference between revisions

← Older edit
Visual
FuzzyBot (talk | contribs)
1,519 edits
Updating to match new version of source page
Tags: Mobile edit Mobile web edit
Natsukium (talk | contribs)
25 edits
No edit summary
Tags: Mobile edit Mobile web edit
 
(39 intermediate revisions by 2 users not shown)
Line 2: Line 2:
'''Nix flakes''' は [https://nixos.org/manual/nix/stable/contributing/experimental-Features.html 試験的な機能] で Nix 2.4 で導入されました。 ([https://nixos.org/manual/nix/unstable/release-notes/rl-2.4.html リリースノートを参照してください])。
'''Nix flakes''' は [https://nixos.org/manual/nix/stable/contributing/experimental-Features.html 試験的な機能] で Nix 2.4 で導入されました。 ([https://nixos.org/manual/nix/unstable/release-notes/rl-2.4.html リリースノートを参照してください])。


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Introduction"></span>
====Introduction====
====概要====
</div>


Nix flakesはNixのプロジェクトに一定の構造を強制し、ロックファイルを用いて依存するプロジェクトのバージョンを指定することでより便利に再現可能なNix式を記述できるようにします。
Nix flakesはNixのプロジェクトに一定の構造を強制し、ロックファイルを用いて依存するプロジェクトのバージョンを指定することでより便利に再現可能なNix式を記述できるようにします。


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-flake.html#description Flake]とは<code>flake.nix</code>というのNixファイルをルートに持つファイルシステムツリーを指します。
* A [https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-flake.html#description flake] refers to a file-system tree whose root directory contains the Nix file specification called <code>flake.nix</code>.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* <code>flake.nix</code>ファイルの内容は、Nix言語でパッケージとその依存関係を宣言するための統一された命名スキーマに従っています。
* The contents of <code>flake.nix</code> file follow a uniform naming schema for declaring packages and their dependencies in the Nix language.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
*  Flakeは外部のソースを指定するために[https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-references URLのような構文]を提供しています。
*  Flakes introduce a [https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-references URL-like syntax] for specifying remote sources.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* 長いURL構文を簡易にするために[https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-registry.html Flakeはレジストリを使用]して短い記号として登録できます。
* To simplify the long URL syntax with shorter names, [https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-registry.html flakes uses a registry] of symbolic identifiers.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* また、Flakesは参照（Gitのrefsの事）とバージョンを固定することができ、それらをプログラムによって照会したり更新したりすることができます。
* Flakes also allow for locking references and versions that can then be queried and updated programmatically.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://nixos.org/manual/nix/stable/command-ref/new-cli/nix.html 実験的なコマンドラインインタフェース]はFlakeの参照を受け取りパッケージのビルド、実行やデプロイができます。
* An [https://nixos.org/manual/nix/stable/command-ref/new-cli/nix.html experimental command-line interface] accepts flake references for expressions that build, run, and deploy packages.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Enable_flakes_temporarily"></span>
====Enable flakes temporarily====
====flakesを一時的に有効にする====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
任意の<code>nix</code>コマンドを使用する場合は、次のコマンドラインオプションを追加します：
When using any <code>nix</code> command, add the following command-line options:
</div>
<syntaxhighlight lang="shell">
<syntaxhighlight lang="shell">
  --experimental-features 'nix-command flakes'
  --experimental-features 'nix-command flakes'
</syntaxhighlight>
</syntaxhighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Enable_flakes_permanently_in_NixOS"></span>
====Enable flakes permanently in NixOS====
====NixOSでflakesを永続的に有効にする====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
[[Overview_of_the_NixOS_Linux_distribution#Declarative_Configuration system configuration |NixOS configuration]]に以下を追加します
Add the following to the [[Overview_of_the_NixOS_Linux_distribution#Declarative_Configuration system configuration |NixOS configuration]]:
</div>


<syntaxHighlight lang=nix>
<syntaxHighlight lang=nix>
Line 55: Line 36:
</syntaxHighlight>
</syntaxHighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Other_Distros,_with_Home-Manager"></span>
=====Other Distros, with Home-Manager=====
=====その他ディストリビューション、Home-Managerあり=====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
home-managerの設定に以下を追加します：
Add the following to your home-manager config:
</div>


<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
Line 67: Line 45:
</syntaxhighlight>
</syntaxhighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Other_Distros,_without_Home-Manager"></span>
=====Other Distros, without Home-Manager=====
=====その他ディストリビューション、Home-Managerなし=====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
{{注記： | [https://github.com/DeterminateSystems/nix-installer Determinate Nix Installer]ではデフォルトでflakesを有効化しています。}}
{{Note | The  [https://github.com/DeterminateSystems/nix-installer Determinate Nix Installer] enables flakes by default.}}
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
次の内容を<code>~/.config/nix/nix.conf</code>または<code>/etc/nix/nix.conf</code>に追記してください:
Add the following to <code>~/.config/nix/nix.conf</code> or <code>/etc/nix/nix.conf</code>:
</div>


<syntaxHighlight lang=text>
<syntaxHighlight lang=text>
Line 83: Line 56:
</syntaxHighlight>
</syntaxHighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Basic_Usage_of_Flake"></span>
===Basic Usage of Flake===
===基本的なFlakeの使用方法===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
この時点でnixコマンドを実行する前に、以下の2つの警告に注意してください。1つは暗号化に関するもの、もう1つはgitに関するものです。
Before running any nix commands at this point, please note the two warnings below: one for encryption and the other for git.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Encryption_WARNING"></span>
====Encryption WARNING====
====暗号化に関する警告====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
{{Warning | flakeファイルの内容は世界的に読み取り可能なNix storeフォルダにコピーされるため、暗号化されていない機密情報はflakeファイルに置かないでください。代わりに[[Comparison of secret managing schemes|secret managing scheme]]を使うべきです。}}
{{Warning | Since contents of flake files are copied to the world-readable Nix store folder, do not put any unencrypted secrets in flake files. You should instead use a [[Comparison of secret managing schemes|secret managing scheme]].}}
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Git_WARNING"></span>
====Git WARNING====
====Gitに関する警告====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Gitリポジトリ内のフレークでは、作業ツリー内のファイルのみがNix storeにコピーされます。
For flakes in git repos, only files in the working tree will be copied to the store.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
したがって、flakeに<code>git</code>を使用する場合は、プロジェクトファイルを作成した後、必ず<code>git add</code>を実行してください。
Therefore, if you use <code>git</code> for your flake, ensure to <code>git add</code> any project files after you first create them.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<div lang="en" dir="ltr" class="mw-content-ltr">
Line 115: Line 77:
</div>
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Generate_flake.nix_file"></span>
====Generate flake.nix file====
====flake.nixファイルを生成する====
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
基本的な方法でFlakeを使い始めるにはプロジェクトディレクトリでflakeコマンドを実行します：
To start the basic usage of flake, run the flake command in the project directory:
</div>


<syntaxHighlight lang=text>
<syntaxHighlight lang=text>
Line 127: Line 86:
</syntaxHighlight>
</syntaxHighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
== Flake schema ==
== Flake schema ==
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
flake.nixファイルはNixファイルですが、特殊な制限が設けられています（これについては後述します）。
The flake.nix file is a Nix file but that has special restrictions (more on that later).
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Flakeは4つのトップレベルアトリビュートを持ちます：
It has 4 top-level attributes:
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* <code>description</code>はflakeを説明する文字列です。
* <code>description</code> is a string describing the flake.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* <code>inputs</code>はflakeの依存関係をアトリビュートセットとして記述したものです。下にスキーマを記述しています。
* <code>inputs</code> is an attribute set of all the dependencies of the flake. The schema is described below.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* <code>outputs</code>はすべてのrealizeされたinputを受け取り、下に記述されたスキーマのようにアトリビュートセットを返す関数です。
* <code>outputs</code> is a function of one argument that takes an attribute set of all the realized inputs, and outputs another attribute set whose schema is described below.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* <code>nixConfig</code>は[https://nixos.org/manual/nix/stable/command-ref/conf-file.html nix.confに使用できる値]を反映しています。これを用いてこのflake特有の設定を反映させることができます。例としてバイナリキャッシュを設定できます。
* <code>nixConfig</code> is an attribute set of values which reflect the [https://nixos.org/manual/nix/stable/command-ref/conf-file.html values given to nix.conf]. This can extend the normal behavior of a user's nix experience by adding flake-specific configuration, such as a binary cache.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Input_schema"></span>
=== Input schema ===
=== Input スキーマ ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
[https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-inputs Nixのflake inputsのマニュアル].
[https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-inputs The nix flake inputs manual].
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
[https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-references Nix flake referencesのマニュアル].
[https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-references The nix flake references manual].
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
inputsアトリビュートはflakeの依存関係を定義します。例えば、システムflakeではシステムをビルドするためにnixpkgsに依存しています。
The inputs attribute defines the dependencies of the flake. For example, nixpkgs has to be defined as a dependency for a system flake in order for the system to build properly.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
Nixpkgsは以下のコードで定義できます:
Nixpkgs can be defined using the following code:
</div>


<code>inputs.nixpkgs.url = "github:NixOS/nixpkgs/<branch name>";</code>
<code>inputs.nixpkgs.url = "github:NixOS/nixpkgs/<branch name>";</code>
Retrieved from "https://wiki.nixos.org/wiki/Flakes/ja"