init | Qlty Docs

$ qlty init [OPTIONS]

Set up Qlty in the current repository

This command will generate an initial project configuration file based on the contents of the repository and write it to .qlty/qlty.toml at the repository root.

When run without the --skip-plugins command, initialization will try to determine a reasonable set of linters and formatters to enable. Certain linters and formatters are enabled based on the detection of a linter configuration file. Others are enabled just based on the presence of target files of the programming language.

Following initialization, the command will print a summary of the configuration.

After generating a configuration file, the command will ask if you want to sample the results of the enabled plugins. Sampling runs each plugin against a small set of targets.

If Qlty is already initialized in the current repository, this command will exit with an error.

Arguments

-y, --yes

Answer yes to all prompts

-n, --no

Answer no to all prompts

--skip-plugins

Skip enabling plugins

--dry-run

Print the generated configuration to stdout instead of saving to disk

--skip-default-source

Initialize without default source

--source

A custom source to use for plugins. This can be a URL(name=url) or a path to a local directory(name=directory)

Examples

Generate a Qlty config for the current repository

$ qlty init

Generate a Qlty config and skip prompts

$ qlty init --no

Generate a Qlty config with no plugins

$ qlty init --skip-plugins