Skip to content

Commit

Permalink
docs: change layout groups
Browse files Browse the repository at this point in the history
  • Loading branch information
ruben-arts committed May 29, 2024
1 parent 18b4903 commit ea8195c
Showing 1 changed file with 68 additions and 68 deletions.
136 changes: 68 additions & 68 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,58 +71,6 @@ Build a package from a recipe

##### **Options:**

###### **Modifying result**

- `--package-format <PACKAGE_FORMAT>`

The package format to use for the build. Can be one of `tar-bz2` or `conda`.
You can also add a compression level to the package format, e.g. `tar-bz2:<number>` (from 1 to 9) or `conda:<number>` (from -7 to 22).

- Default value: `conda`

- `--no-include-recipe`

Don't store the recipe in the final package

- Possible values: `true`, `false`


- `--no-test`

Don't run the tests after building the package

- Default value: `false`
- Possible values: `true`, `false`


- `--color-build-log`

Don't force colors in the output of the build script

- Default value: `true`
- Possible values: `true`, `false`


- `--output-dir <OUTPUT_DIR>`

Output directory for build artifacts.

- Default value: `./output`

- `--skip-existing <SKIP_EXISTING>`

Whether to skip packages that already exist in any channel If set to `none`, do not skip any packages, default when not specified. If set to `local`, only skip packages that already exist locally, default when using `--skip-existing. If set to `all`, skip packages that already exist in any channel

- Default value: `none`
- Possible values:
- `none`:
Do not skip any packages
- `local`:
Skip packages that already exist locally
- `all`:
Skip packages that already exist in any channel


- `-r`, `--recipe <RECIPE>`

The recipe file or directory containing `recipe.yaml`. Defaults to the current directory
Expand Down Expand Up @@ -231,6 +179,58 @@ You can also add a compression level to the package format, e.g. `tar-bz2:<numbe
- Possible values: `true`, `false`


###### **Modifying result**

- `--package-format <PACKAGE_FORMAT>`

The package format to use for the build. Can be one of `tar-bz2` or `conda`.
You can also add a compression level to the package format, e.g. `tar-bz2:<number>` (from 1 to 9) or `conda:<number>` (from -7 to 22).

- Default value: `conda`

- `--no-include-recipe`

Don't store the recipe in the final package

- Possible values: `true`, `false`


- `--no-test`

Don't run the tests after building the package

- Default value: `false`
- Possible values: `true`, `false`


- `--color-build-log`

Don't force colors in the output of the build script

- Default value: `true`
- Possible values: `true`, `false`


- `--output-dir <OUTPUT_DIR>`

Output directory for build artifacts.

- Default value: `./output`

- `--skip-existing <SKIP_EXISTING>`

Whether to skip packages that already exist in any channel If set to `none`, do not skip any packages, default when not specified. If set to `local`, only skip packages that already exist locally, default when using `--skip-existing. If set to `all`, skip packages that already exist in any channel

- Default value: `none`
- Possible values:
- `none`:
Do not skip any packages
- `local`:
Skip packages that already exist locally
- `all`:
Skip packages that already exist in any channel





Expand All @@ -250,6 +250,14 @@ These test files are written at "package creation time" and are part of the pack

##### **Options:**

###### **Modifying result**

- `--output-dir <OUTPUT_DIR>`

Output directory for build artifacts.

- Default value: `./output`

- `-c`, `--channel <CHANNEL>`

Channels to use when testing
Expand Down Expand Up @@ -288,14 +296,6 @@ These test files are written at "package creation time" and are part of the pack
Path to an auth-file to read authentication information from


###### **Modifying result**

- `--output-dir <OUTPUT_DIR>`

Output directory for build artifacts.

- Default value: `./output`




Expand All @@ -307,6 +307,14 @@ Rebuild a package from a package file instead of a recipe

##### **Options:**

###### **Modifying result**

- `--output-dir <OUTPUT_DIR>`

Output directory for build artifacts.

- Default value: `./output`

- `-p`, `--package-file <PACKAGE_FILE>`

The package file to rebuild
Expand Down Expand Up @@ -348,14 +356,6 @@ Rebuild a package from a package file instead of a recipe
Path to an auth-file to read authentication information from


###### **Modifying result**

- `--output-dir <OUTPUT_DIR>`

Output directory for build artifacts.

- Default value: `./output`




Expand Down

0 comments on commit ea8195c

Please sign in to comment.