renku config

Get and set Renku repository or global options.

Description

Save useful Renku configuration directives in a simple human-readable ini file. The values are used by other renku commands and by interactive sessions.

Check the Available configuration values section to get more information on the available values.

Commands and options

renku config

Interact with renku configuration.

renku config [OPTIONS] COMMAND [ARGS]...

remove

Remove a configuration value.

KEY is of the form <group>.<entry>, e.g. ‘interactive.default_url’.

renku config remove [OPTIONS] KEY

Options

--global: Remove from global configuration only.

Arguments

KEY: Required argument

set

Set a configuration value.

KEY is of the form <group>.<entry>, e.g. ‘interactive.default_url’.

renku config set [OPTIONS] KEY VALUE

Options

--global: Store to global configuration only.

Arguments

KEY: Required argument

VALUE: Required argument

show

Show current configuration.

KEY is of the form <group>.<entry>, e.g. ‘interactive.default_url’.

renku config show [OPTIONS] [KEY]

Options

--local: Read from local configuration only. NOTE: This argument is mutually exclusive with arguments: [–default, –global].

--global: Read from global configuration only. NOTE: This argument is mutually exclusive with arguments: [–default, –local].

--default: Show default values if applicable. NOTE: This argument is mutually exclusive with arguments: [–global, –local].

Arguments

KEY: Optional argument

Examples

You can set various Renku configuration options, for example the image registry URL, with a command like:

$ renku config set interactive.default_url "/tree"

By default, configuration is stored locally in the project’s directory. Use --global option to store configuration for all projects in your home directory.

To remove a specific key from configuration use:

$ renku config remove interactive.default_url

By default, only local configuration is searched for removal. Use --global option to remove a global configuration value.

Available configuration values

The following values are used by renku-python and available for the renku config command:

Name	Description	Default
`data_directory`	Path to the data directory (read-only after project creation)	`data/`
`dataverse.access_token`	Access token for Dataverse API	`None`
`dataverse.server_url`	URL for the Dataverse API server to use	`None`
`default_dataset_add_action`	Default action when adding files to datasets. Can be either `copy` or `move`.	`None`
`lfs_threshold`	Threshold file size below which files are not added to git LFS	`100kb`
`show_lfs_message`	Whether to show messages about files being added to git LFS or not	`true`
`show_login_warning`	Whether to warn when logging in to Renku inside a project that causes project’s git remote to be changed.	`true`
`ssh_supported`	Whether the image in this project contains an SSH server on port 22 for SSH connections. Used to override the corresponding project template setting.	`false`
`zenodo.access_token`	Access token for Zenodo API	`None`

See the section on renku.ini for more configuration values.