2022-08-13 19:34:46 +00:00
|
|
|
# Top Level API
|
2023-01-28 20:49:10 +00:00
|
|
|
|
2022-08-13 19:34:46 +00:00
|
|
|
`digga`'s top level API. API Containers are documented in their respective sub-chapter:
|
|
|
|
|
|
|
|
- [Channels](./api-reference-channels.md)
|
|
|
|
- [Home](./api-reference-home.md)
|
|
|
|
- [Devshell](./api-reference-devshell.md)
|
|
|
|
- [NixOS](./api-reference-nixos.md)
|
|
|
|
- [Darwin](./api-reference-darwin.md)
|
|
|
|
|
|
|
|
## channelsConfig
|
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
nixpkgs config for all channels
|
2022-08-13 19:34:46 +00:00
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
_*Type*_:
|
2022-08-13 19:34:46 +00:00
|
|
|
attribute set or path convertible to it
|
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
_*Default*_
|
2022-08-13 19:34:46 +00:00
|
|
|
|
|
|
|
```
|
|
|
|
{}
|
|
|
|
```
|
|
|
|
|
|
|
|
## inputs
|
2023-01-28 20:49:10 +00:00
|
|
|
|
2022-08-13 19:34:46 +00:00
|
|
|
The flake's inputs
|
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
_*Type*_:
|
2022-08-13 19:34:46 +00:00
|
|
|
attribute set of nix flakes
|
|
|
|
|
|
|
|
## outputsBuilder
|
2023-01-28 20:49:10 +00:00
|
|
|
|
2022-08-13 19:34:46 +00:00
|
|
|
builder for flake system-spaced outputs
|
|
|
|
The builder gets passed an attrset of all channels
|
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
_*Type*_:
|
2022-08-13 19:34:46 +00:00
|
|
|
function that evaluates to a(n) attribute set or path convertible to it
|
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
_*Default*_
|
2022-08-13 19:34:46 +00:00
|
|
|
|
|
|
|
```
|
|
|
|
"channels: { }"
|
|
|
|
```
|
|
|
|
|
|
|
|
## self
|
2023-01-28 20:49:10 +00:00
|
|
|
|
2022-08-13 19:34:46 +00:00
|
|
|
The flake to create the DevOS outputs for
|
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
_*Type*_:
|
2022-08-13 19:34:46 +00:00
|
|
|
nix flake
|
|
|
|
|
|
|
|
## supportedSystems
|
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
The systems supported by this flake
|
2022-08-13 19:34:46 +00:00
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
_*Type*_:
|
2022-08-13 19:34:46 +00:00
|
|
|
list of strings
|
|
|
|
|
2023-01-28 20:49:10 +00:00
|
|
|
_*Default*_
|
2022-08-13 19:34:46 +00:00
|
|
|
|
|
|
|
```
|
|
|
|
["aarch64-linux","aarch64-darwin","i686-linux","x86_64-darwin","x86_64-linux"]
|
|
|
|
```
|