diff --git a/cli/commands/ci/workflows/index.md b/cli/commands/ci/workflows/index.md index 735fb2ad..c6f6baba 100644 --- a/cli/commands/ci/workflows/index.md +++ b/cli/commands/ci/workflows/index.md @@ -15,7 +15,7 @@ kbc ci workflows [flags] You will be prompted to choose which workflows you want to generate: - `validate` - validates all branches on change - `push` - pushes each change in the main branch to the project -- `pull` - pulls the main branch from the project every five minutes +- `pull` - pulls the main branch from the project each hour ## Options @@ -23,7 +23,7 @@ You will be prompted to choose which workflows you want to generate: : Name of the main branch for push/pull workflows (default "main") `--ci-pull ` -: Create a workflow to sync the main branch from the project every five minutes (default true) +: Create a workflow to sync the main branch from the project each hour (default true) `--ci-push ` : Create a workflow to push changes in the main branch to the project (default true) diff --git a/cli/commands/dbt/generate/env/index.md b/cli/commands/dbt/generate/env/index.md index eb29c5f1..a478d0aa 100644 --- a/cli/commands/dbt/generate/env/index.md +++ b/cli/commands/dbt/generate/env/index.md @@ -6,10 +6,10 @@ permalink: /cli/commands/dbt/generate/env/ * TOC {:toc} -**Generates sources in the dbt project directory.** +**Generates environment variables for use with dbt.** ``` -kbc dbt generate sources [flags] +kbc dbt generate env [flags] ``` The command must be run in a directory with a dbt project (i.e., containing `dbt_project.yml`) or its subdirectory. diff --git a/cli/commands/index.md b/cli/commands/index.md index 1aa41e27..822ffc37 100644 --- a/cli/commands/index.md +++ b/cli/commands/index.md @@ -64,7 +64,7 @@ kbc help local create row | [kbc remote table detail](/cli/commands/remote/table/detail/) | Print [table](https://help.keboola.com/storage/tables/) details. | | [kbc remote table import](/cli/commands/remote/table/import/) | Import data to a [table](https://help.keboola.com/storage/tables/) from a [file](https://help.keboola.com/storage/files/). | | [kbc remote table unload](/cli/commands/remote/table/unload/) | Unload a [table](https://help.keboola.com/storage/tables/) into a [file](https://help.keboola.com/storage/files/). | -| [kbc remote workspace](/cli/commands/remote/create/) | Manage workspaces in the project. | +| [kbc remote workspace](/cli/commands/remote/workspace/) | Manage workspaces in the project. | | [kbc remote workspace create](/cli/commands/remote/workspace/create/) | Create a workspace in the project. | | [kbc remote workspace delete](/cli/commands/remote/workspace/delete/) | Delete a workspace in the project. | | [kbc remote workspace detail](/cli/commands/remote/workspace/detail/) | Print workspace details and credentials. | diff --git a/cli/commands/local/create/config/index.md b/cli/commands/local/create/config/index.md index 00737034..c0f0f853 100644 --- a/cli/commands/local/create/config/index.md +++ b/cli/commands/local/create/config/index.md @@ -68,4 +68,4 @@ Created new config "main/extractor/keboola.ex-db-mysql/invoices" - [All Commands](/cli/commands/) - [Create Configuration Row](/cli/commands/local/create/row/) -- [Create Branch](/cli/commands/remote/create/brabch/) +- [Create Branch](/cli/commands/remote/create/branch/) diff --git a/cli/commands/local/create/row/index.md b/cli/commands/local/create/row/index.md index e49ab498..7220a9bd 100644 --- a/cli/commands/local/create/row/index.md +++ b/cli/commands/local/create/row/index.md @@ -54,7 +54,7 @@ Created new config row "main/extractor/keboola.ex-db-mysql/invoices/rows/custome ``` ``` -➜ kbc create config -n customer -b main -c invoices +➜ kbc create row -n customer -b main -c invoices Created new config row "main/extractor/keboola.ex-db-mysql/invoices/rows/customer" ``` @@ -62,4 +62,4 @@ Created new config row "main/extractor/keboola.ex-db-mysql/invoices/rows/custome - [All Commands](/cli/commands/) - [Create Configuration](/cli/commands/local/create/config/) -- [Create Branch](/cli/commands/remote/create/brabch/) +- [Create Branch](/cli/commands/remote/create/branch/) diff --git a/cli/commands/local/fix-paths/index.md b/cli/commands/local/fix-paths/index.md index 391e035e..7dc454af 100644 --- a/cli/commands/local/fix-paths/index.md +++ b/cli/commands/local/fix-paths/index.md @@ -18,6 +18,9 @@ It is run automatically after [pull](/cli/commands/sync/pull/). ## Options +`--cleanup` +: Remove conflicting destination paths during rename + `--dry-run` : Preview all paths that would be affected diff --git a/cli/commands/local/persist/index.md b/cli/commands/local/persist/index.md index 02c4aad0..4b500a99 100644 --- a/cli/commands/local/persist/index.md +++ b/cli/commands/local/persist/index.md @@ -14,7 +14,8 @@ kbc local persist [flags] Or shorter: ``` -kbc p [flags] +kbc persist [flags] +kbc pt [flags] ``` Propagate changes in the [local directory](/cli/structure/) to the manifest. When you manually create a configuration or a row (e.g., by diff --git a/cli/commands/remote/file/download/index.md b/cli/commands/remote/file/download/index.md index c7f949c2..2a6b4de5 100644 --- a/cli/commands/remote/file/download/index.md +++ b/cli/commands/remote/file/download/index.md @@ -26,6 +26,9 @@ kbc remote file download [id] [flags] By default, sliced files are stitched together to form a single file. If this flag is set when downloading a sliced file, the resulting file will instead be stored as a directory, and each slice will be stored as a separate file in that directory. +`--without-decompress` +: Do not decompress the downloaded files or sliced files. + [Global Options](/cli/commands/#global-options) ### Examples diff --git a/cli/commands/remote/file/upload/index.md b/cli/commands/remote/file/upload/index.md index 9522d979..5d504436 100644 --- a/cli/commands/remote/file/upload/index.md +++ b/cli/commands/remote/file/upload/index.md @@ -31,7 +31,7 @@ kbc remote file upload [flags] ### Examples ``` -➜ $ kbc remote file upload --name file1 --data ./name.csv --tags tag1,tag2 +➜ $ kbc remote file upload --file-name file1 --data ./name.csv --file-tags tag1,tag2 File "file1" uploaded with file id "1234567". ``` diff --git a/cli/commands/remote/index.md b/cli/commands/remote/index.md index e6f259e1..490e0cbf 100644 --- a/cli/commands/remote/index.md +++ b/cli/commands/remote/index.md @@ -31,7 +31,7 @@ kbc remote [command] | [kbc remote table detail](/cli/commands/remote/table/detail/) | Print [table](https://help.keboola.com/storage/tables/) details. | | [kbc remote table import](/cli/commands/remote/table/import/) | Import data to a [table](https://help.keboola.com/storage/tables/) from a [file](https://help.keboola.com/storage/files/). | | [kbc remote table unload](/cli/commands/remote/table/unload/) | Unload a [table](https://help.keboola.com/storage/tables/) into a [file](https://help.keboola.com/storage/files/). | -| [kbc remote workspace](/cli/commands/remote/create/) | Manage workspaces in the project. | +| [kbc remote workspace](/cli/commands/remote/workspace/) | Manage workspaces in the project. | | [kbc remote workspace create](/cli/commands/remote/workspace/create/) | Create a workspace in the project. | | [kbc remote workspace delete](/cli/commands/remote/workspace/delete/) | Delete a workspace in the project. | | [kbc remote workspace detail](/cli/commands/remote/workspace/detail/) | Print workspace details and credentials. | diff --git a/cli/commands/remote/job/run/index.md b/cli/commands/remote/job/run/index.md index b6cab3e5..d0fc1469 100644 --- a/cli/commands/remote/job/run/index.md +++ b/cli/commands/remote/job/run/index.md @@ -22,7 +22,7 @@ If no `@tag` is specified, the default version of the component is used. : Keboola instance URL, e.g., `connection.keboola.com` `--timeout ` -: How long to wait for the job to finish (default `2m`) +: How long to wait for the job to finish (default `5m`) Specified as a sequence of decimal numbers with unit suffixes, e.g., `5m10s` or `1.5h`. Available units are `ms`, `s`, `m`, and `h`. diff --git a/cli/commands/remote/table/download/index.md b/cli/commands/remote/table/download/index.md index 1c8791ac..f4033642 100644 --- a/cli/commands/remote/table/download/index.md +++ b/cli/commands/remote/table/download/index.md @@ -61,6 +61,12 @@ kbc remote table download [table] [flags] Accepts a semicolon-separated list of expressions, each of which specifies a column and a comparison to one or more values, such as `First_Name=Ivan,Pavel;Birth_Date>=1990-01-01` +`--timeout ` +: How long to wait for the unload job to finish (default `2m`) + + Specified as a sequence of decimal numbers with unit suffixes, e.g., `5m10s` or `1.5h`. + Available units are `ms`, `s`, `m`, and `h`. + `--allow-sliced` : Allow sliced files to appear sliced locally. (default false) diff --git a/cli/commands/remote/table/unload/index.md b/cli/commands/remote/table/unload/index.md index 5a06b191..227f0f89 100644 --- a/cli/commands/remote/table/unload/index.md +++ b/cli/commands/remote/table/unload/index.md @@ -50,7 +50,7 @@ kbc remote table unload [table] [flags] Accepts a semicolon-separated list of expressions, each of which specifies a column and a comparison to one or more values, such as `First_Name=Ivan,Pavel;Birth_Date>=1990-01-01` `--timeout ` -: How long to wait for the storage job to finish (default `2m`) +: How long to wait for the storage job to finish (default `5m`) Specified as a sequence of decimal numbers with unit suffixes, e.g., `5m10s` or `1.5h`. Available units are `ms`, `s`, `m`, and `h`. diff --git a/cli/commands/sync/init/index.md b/cli/commands/sync/init/index.md index 914464bb..c5fed323 100644 --- a/cli/commands/sync/init/index.md +++ b/cli/commands/sync/init/index.md @@ -40,7 +40,7 @@ Sets `true` to the `allowTargetEnv` field in the [manifest.json](/cli/structure/ : Name of the main branch for push/pull workflows (default "main") `--ci-pull ` -: Create a workflow to sync the main branch from the project every 5 minutes (default true) +: Create a workflow to sync the main branch from the project each hour (default true) `--ci-push ` : Create a workflow to push changes in the main branch to the project (default true)