config¶
See also: config guide
mio config¶
Command group for config
When run without arguments, displays current config from all sources
Usage
mio config [OPTIONS] COMMAND [ARGS]...
create¶
Create a new default config for a model in the user config directory, given the name of a model and the name of a config id.
`
mio config create MyModel some-config-id
`
Use –list to see the available model names.
Pass required key/value pairs with –value key=value, e.g.
mio config create MyModel some-config –value device=abc
By default, created configs are saved to the user config directory with an escaped file name
based on the passed id ,
but an explicit output path can be passed.
Note that creating configs in locations
that are not in the user config directory will prevent mio from finding them.
(see mio config user )
Usage
mio config create [OPTIONS] [MODEL] id
Options
- -f, --force¶
Overwrite existing config file
- -v, --value <value>¶
Pass key/value pairs to the model like key=value
- --output <output>¶
Provide an explicit output path for the yaml config
- --list¶
List available models
Arguments
- MODEL¶
Optional argument
- id¶
Optional argument
global¶
Command group for global configuration directory
When run without arguments, displays contents of current global config
Usage
mio config global [OPTIONS] COMMAND [ARGS]...
path¶
Location of the global mio config
Usage
mio config global path [OPTIONS]
list¶
Display the available configs in the user config directory and provided by mio.
By default, results are truncated for narrow consoles - models within mio.models are displayed with only a leading ., and paths of builtin configs are shown relative to the package config directory
Usage
mio config list [OPTIONS]
Options
- -v, --verbose¶
Display more verbose output -v: Display full model identifiers and config paths
open¶
Open a config with the default text editor.
To open a config with a specific editor, use path (see mio config path –help)
Usage
mio config open [OPTIONS] id
Arguments
- id¶
Required argument
path¶
Print the path for a config
e.g. to open a config for editing
`
open $(mio config path my-config)
`
Usage
mio config path [OPTIONS] id
Arguments
- id¶
Required argument
user¶
Command group for the user config directory
When invoked without arguments, displays the contents of the current user directory
Usage
mio config user [OPTIONS] COMMAND [ARGS]...
create¶
Create a user directory, setting it as the default in the global config
- Args:
user_dir (Path): Path to the directory to create force (bool): Overwrite existing config file if it exists
Usage
mio config user create [OPTIONS] [USER_DIR]
Options
- --force, --no-force¶
Overwrite existing config file if it exists
- --clean, --dirty¶
Create a fresh mio_config.yaml file containing only the user_dir. Otherwise, by default (–dirty), any other settings from .env, pyproject.toml, etc.are included in the created user config file.
- --dry-run, --no-dry-run¶
Show the config that would be written and where it would go without doing anything
Arguments
- USER_DIR¶
Optional argument
path¶
Location of the current user config
Usage
mio config user path [OPTIONS]