Codchi
Docs
Docs

codchi.enableRecommendedConfig

Whether to enable recommended NixOS options.

Type: boolean

Default: true

Example: true

Declared by:

codchi.docker.enable

Whether to enable the docker daemon. This also adds the codchi user to the docker group and installs docker-compose.

Type: boolean

Default: false

Declared by:

codchi.driver.wsl.useWindowsGPU

Whether to enable OpenGL / GPU driver from the Windows host.

Type: boolean

Default: true

Example: true

Declared by:

codchi.secrets.env

Secrets / variables which must be set by each Codchi user. They will be available in each shell session, prefixed by CODCHI_, inside this code machine, so don’t use this for super sensitive secrets.

Possible use cases:

  • GitHub / GitLab tokens for automatic git setup / repo cloning

Type: attribute set of (submodule)

Default: { }

Example:

{ # Will be available as $CODCHI_GITLAB_TOKEN GITLAB_TOKEN = { description = '' Access token with read_api, read_repository & write_repository scopes. Can be created here: <https://gitlab.example.com/-/user_settings/personal_access_tokens>. Syntax: `oauth2:glpat-XXXXXXXXXXXXXXXXXXXX`. ''; }; }

Declared by:

codchi.secrets.env.<name>.description

A short text describing what this secret is used for and how it should be obtained. This will be shown to the user during codchi rebuild.

Type: strings concatenated with “\n”

Declared by:

codchi.secrets.env.<name>.name

Name of this environment variable. Will be prefixed by CODCHI_.

Type: string matching the pattern ^[a-zA-Z0-9:_\.-]*$

Default: "‹name›"

Declared by:

codchi.welcome.enable

Whether to enable Codchi’s welcome message.

Type: boolean

Default: true

Example: true

Declared by:

codchi.welcome.extraText

A message which is appended to codchi.welcome.text and shown when opening a shell.

Type: strings concatenated with “\n”

Default: ""

Declared by:

codchi.welcome.text

Codchi’s default message which is shown when opening a shell. Use codchi.welcome.extraText to append your own message. Only override this if you don’t wan’t Codchi to show the default text.

Type: strings concatenated with “\n”

Default:

'' ❄️ Welcome to your code machine! ❄️ To get started with \e[1;36mCodchi\e[0m, read the docs at <https://codchi.dev/>. If you encounter problems please open an issue at <https://github.com/aformatik/codchi/issues>. ''

Declared by:

programs.java.packages

List of JDKs which should be symlinked to ~/.jdks (for IDEs lik IntelliJ).

Type: attribute set of package

Default: { }

Example:

{ openjdk19 = pkgs.jdk19; }

Declared by: