diff --git a/src/content/configuration/cli.mdx b/src/content/configuration/cli.mdx index 2aa0f660..0555468c 100644 --- a/src/content/configuration/cli.mdx +++ b/src/content/configuration/cli.mdx @@ -71,6 +71,20 @@ Note: some options are only available as flags. For a full list of available opt Flags must be passed as `--kebab-case` whereas options are `camelCase`. Flags take precedence over configuration options. When passing a flag without value, it is treated as `true`. Where an array is accepted, specify the flag multiple times (once for each value). +### Flags + +- Flags take precedence over options specified in config file and Github Action. + +- When passing a flag without value, it is treated as `true`. e.g.: + ```sh + $ npx chromatic --dry-run -t + ``` +- Where an `array` is accepted, specify the flag multiple times (once for each value). e.g.: + ```sh + $ npx chromatic --externals "my-folder/**" --externals "another-folder/**" -t + ``` + + ### Chromatic Config File The configuration file is stored in the root of your project folder as `./chromatic.config.json`. You can use the `--config-file` flag to customize the Chromatic configuration file name and path. diff --git a/src/content/configuration/configuration-reference.mdx b/src/content/configuration/configuration-reference.mdx index feb614ff..f2d79cf2 100644 --- a/src/content/configuration/configuration-reference.mdx +++ b/src/content/configuration/configuration-reference.mdx @@ -9,21 +9,18 @@ import ConfigurationOptions from "../../components/ConfigurationOptions.astro"; # Configuration reference -These options control how Chromatic behaves via the [CLI](/docs/cli), [config file](/docs/cli#chromatic-config-file) and the [Github Action](/docs/github-actions). Refer to [branching docs](/docs/branching-and-baselines) and [diagnosing CLI issues](/docs/cli/#flags-to-help-diagnose-build-issues-with-the-cli) to learn more about when to use some of these flags. +These options control how Chromatic behaves via the [CLI](/docs/cli), [config file](/docs/cli#chromatic-config-file) and the [Github Action](/docs/github-actions). Refer to [branching docs](/docs/branching-and-baselines) and [diagnosing CLI issues](/docs/cli/#flags-to-help-diagnose-build-issues-with-the-cli) for more context on when to use some of these flags. -Note that the config file only supports a subset of these options. Some of the option are exclusive to either the CLI or the config file. The next section tags each option with the appropriate context. - -## Options - -Flags take precedence over configuration options. When passing a flag without value, it is treated as true. Where an array is accepted, specify the flag multiple times (once for each value). - - +Note that the config file only supports a subset of these options. Some of the option are exclusive to either the CLI or the config +file. The next section tags each option with the appropriate context.
+ **Glob Types**: Where supported, globs are handled via [picomatch]. +
-Where supported, globs are handled via [picomatch]. +## Options - + ## Environment variables