os/doc/api-reference.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

64 lines
987 B
Markdown
Raw Normal View History

# Top Level API
2022-11-20 22:28:23 +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
nixpkgs config for all channels
_*Type*_:
attribute set or path convertible to it
2022-11-20 22:28:23 +00:00
_*Default*_
```
{}
```
## inputs
2022-11-20 22:28:23 +00:00
The flake's inputs
_*Type*_:
attribute set of nix flakes
## outputsBuilder
2022-11-20 22:28:23 +00:00
builder for flake system-spaced outputs
The builder gets passed an attrset of all channels
_*Type*_:
function that evaluates to a(n) attribute set or path convertible to it
2022-11-20 22:28:23 +00:00
_*Default*_
```
"channels: { }"
```
## self
2022-11-20 22:28:23 +00:00
The flake to create the DevOS outputs for
_*Type*_:
nix flake
## supportedSystems
The systems supported by this flake
_*Type*_:
list of strings
2022-11-20 22:28:23 +00:00
_*Default*_
```
["aarch64-linux","aarch64-darwin","i686-linux","x86_64-darwin","x86_64-linux"]
```