Skip to main content

# kater job run

Runs one job now, then the jobs set to run after it.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

It runs the job even when its schedule is off. The answer gives the run, and under `followed_by` the runs of the jobs that followed it.

## Examples

```bash
# Run the sync_snowflake job now, then the jobs that run after it
kater job run sync_snowflake --kater-root . --deployment production
# Run the tests, with the secrets in the deployment's dotenv file
kater job run test_snowflake --kater-root . --deployment production --env-file /srv/kater/production.env
```

## Arguments

<div class="cli-options">

| Argument | Description |
| --- | --- |
| `<job-name>` | The job to run, by its name in `kater.config.yaml`, such as `sync_snowflake`. |

</div>

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--deployment <name>` | Required. The deployment the job belongs to, such as `production`. A job of another deployment is refused. |
| `--env-file <file>` | A dotenv file that the deployment owns, with secrets such as warehouse credentials. A variable already in the environment wins over the file. |

</div>

It also takes the [global options](https://kater.ai/docs/cli-reference/global-options/) `--json`, `--kater-root`, `--scope` and `--help`.

## When it fails

The command fails when the job fails, or when a job that runs after it fails. Each run keeps its own status. When another worker holds the deployment, the run stays `queued`, and the next `kater job tick` runs it.

## See also

- [`kater job`](https://kater.ai/docs/cli-reference/job/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Arguments
Options
When it fails
See also

Kater CLI Run Kater's services job

kater job run

Runs one job now, then the jobs set to run after it.

It runs the job even when its schedule is off. The answer gives the run, and under followed_by the runs of the jobs that followed it.

Examples

# Run the sync_snowflake job now, then the jobs that run after it
kater job run sync_snowflake --kater-root . --deployment production
# Run the tests, with the secrets in the deployment's dotenv file
kater job run test_snowflake --kater-root . --deployment production --env-file /srv/kater/production.env

Arguments

Argument	Description
`<job-name>`	The job to run, by its name in `kater.config.yaml`, such as `sync_snowflake`.

Options

Option	Description
`--deployment <name>`	Required. The deployment the job belongs to, such as `production`. A job of another deployment is refused.
`--env-file <file>`	A dotenv file that the deployment owns, with secrets such as warehouse credentials. A variable already in the environment wins over the file.

It also takes the global options --json, --kater-root, --scope and --help.

When it fails

The command fails when the job fails, or when a job that runs after it fails. Each run keeps its own status. When another worker holds the deployment, the run stays queued, and the next kater job tick runs it.

See also