# Refresh commands

Signatures, flags and examples for recala refresh.

## Use these commands

Examples assume you have signed in and selected the intended organization. Set shell variables such as `ARTICLE_ID` to ids from the corresponding list command. Set `PUBLICATION_TIME` to a future local time in YYYY-MM-DDTHH:MM format.

Badges describe the command’s strongest effect; a preview or read-only option may do less. [Guarded writes can require confirmation even without --yes](https://recala.co/developers/agents/#guarded). “Needs a person” covers identity, consent and credentials.

### [`recala refresh pause`](https://recala.co/developers/cli/refresh/#cmd-refresh-pause)

Pause auto-refresh for one article.

writes Acts on an organization

```
recala refresh pause ARTICLE_ID [OPTIONS]
```

Replace uppercase arguments with your own values. Replace [OPTIONS] with the flags you need, or omit it.

| Flag | Required | Description |
| --- | --- | --- |
| `--json` | No | Print one JSON document (errors as JSON on stderr). |
| `--org` | No | Company name, slug or id (else RECALA_ORG, else recala company use). |
| `--dry-run` | No | Say what would change without changing it. |

#### Examples

Set the named shell variables to your own values before running.

```
recala refresh pause "$ARTICLE_ID"
```

**Exit codes** [`0` OK](https://recala.co/developers/reference/#exit-0) [`1` ERROR](https://recala.co/developers/reference/#exit-1) [`2` USAGE](https://recala.co/developers/reference/#exit-2) [`3` NOT_AUTHENTICATED](https://recala.co/developers/reference/#exit-3) [`4` FORBIDDEN](https://recala.co/developers/reference/#exit-4) [`5` NOT_FOUND](https://recala.co/developers/reference/#exit-5) [`6` CONFLICT](https://recala.co/developers/reference/#exit-6) [`7` INVALID](https://recala.co/developers/reference/#exit-7) [`8` RATE_LIMITED](https://recala.co/developers/reference/#exit-8) [`9` UNAVAILABLE](https://recala.co/developers/reference/#exit-9) [`10` CONFIRMATION_REQUIRED](https://recala.co/developers/reference/#exit-10) [`11` PAYMENT_REQUIRED](https://recala.co/developers/reference/#exit-11)

API commands share the CLI’s HTTP error mapping. [Read human and JSON output rules](https://recala.co/developers/reference/#json-output).

### [`recala refresh resume`](https://recala.co/developers/cli/refresh/#cmd-refresh-resume)

Resume auto-refresh for one article.

writes Acts on an organization

```
recala refresh resume ARTICLE_ID [OPTIONS]
```

Replace uppercase arguments with your own values. Replace [OPTIONS] with the flags you need, or omit it.

| Flag | Required | Description |
| --- | --- | --- |
| `--json` | No | Print one JSON document (errors as JSON on stderr). |
| `--org` | No | Company name, slug or id (else RECALA_ORG, else recala company use). |
| `--dry-run` | No | Say what would change without changing it. |

#### Examples

Set the named shell variables to your own values before running.

```
recala refresh resume "$ARTICLE_ID"
```

**Exit codes** [`0` OK](https://recala.co/developers/reference/#exit-0) [`1` ERROR](https://recala.co/developers/reference/#exit-1) [`2` USAGE](https://recala.co/developers/reference/#exit-2) [`3` NOT_AUTHENTICATED](https://recala.co/developers/reference/#exit-3) [`4` FORBIDDEN](https://recala.co/developers/reference/#exit-4) [`5` NOT_FOUND](https://recala.co/developers/reference/#exit-5) [`6` CONFLICT](https://recala.co/developers/reference/#exit-6) [`7` INVALID](https://recala.co/developers/reference/#exit-7) [`8` RATE_LIMITED](https://recala.co/developers/reference/#exit-8) [`9` UNAVAILABLE](https://recala.co/developers/reference/#exit-9) [`10` CONFIRMATION_REQUIRED](https://recala.co/developers/reference/#exit-10) [`11` PAYMENT_REQUIRED](https://recala.co/developers/reference/#exit-11)

API commands share the CLI’s HTTP error mapping. [Read human and JSON output rules](https://recala.co/developers/reference/#json-output).

### [`recala refresh runs`](https://recala.co/developers/cli/refresh/#cmd-refresh-runs)

Status of one refresh run.

read Acts on an organization

```
recala refresh runs REFRESH_ID [OPTIONS]
```

Replace uppercase arguments with your own values. Replace [OPTIONS] with the flags you need, or omit it.

| Flag | Required | Description |
| --- | --- | --- |
| `--json` | No | Print one JSON document (errors as JSON on stderr). |
| `--org` | No | Company name, slug or id (else RECALA_ORG, else recala company use). |

#### Examples

Set the named shell variables to your own values before running.

```
recala refresh runs "$REFRESH_ID"
```

**Exit codes** [`0` OK](https://recala.co/developers/reference/#exit-0) [`1` ERROR](https://recala.co/developers/reference/#exit-1) [`2` USAGE](https://recala.co/developers/reference/#exit-2) [`3` NOT_AUTHENTICATED](https://recala.co/developers/reference/#exit-3) [`4` FORBIDDEN](https://recala.co/developers/reference/#exit-4) [`5` NOT_FOUND](https://recala.co/developers/reference/#exit-5) [`6` CONFLICT](https://recala.co/developers/reference/#exit-6) [`7` INVALID](https://recala.co/developers/reference/#exit-7) [`8` RATE_LIMITED](https://recala.co/developers/reference/#exit-8) [`9` UNAVAILABLE](https://recala.co/developers/reference/#exit-9) [`11` PAYMENT_REQUIRED](https://recala.co/developers/reference/#exit-11)

API commands share the CLI’s HTTP error mapping. [Read human and JSON output rules](https://recala.co/developers/reference/#json-output).

### [`recala refresh show`](https://recala.co/developers/cli/refresh/#cmd-refresh-show)

Auto-refresh setting, what is due, spend.

read Acts on an organization

```
recala refresh show [OPTIONS]
```

Replace [OPTIONS] with the flags you need, or omit it.

| Flag | Required | Description |
| --- | --- | --- |
| `--json` | No | Print one JSON document (errors as JSON on stderr). |
| `--org` | No | Company name, slug or id (else RECALA_ORG, else recala company use). |

#### Examples

Set the named shell variables to your own values before running.

```
recala refresh show
```

**Exit codes** [`0` OK](https://recala.co/developers/reference/#exit-0) [`1` ERROR](https://recala.co/developers/reference/#exit-1) [`2` USAGE](https://recala.co/developers/reference/#exit-2) [`3` NOT_AUTHENTICATED](https://recala.co/developers/reference/#exit-3) [`4` FORBIDDEN](https://recala.co/developers/reference/#exit-4) [`5` NOT_FOUND](https://recala.co/developers/reference/#exit-5) [`6` CONFLICT](https://recala.co/developers/reference/#exit-6) [`7` INVALID](https://recala.co/developers/reference/#exit-7) [`8` RATE_LIMITED](https://recala.co/developers/reference/#exit-8) [`9` UNAVAILABLE](https://recala.co/developers/reference/#exit-9) [`11` PAYMENT_REQUIRED](https://recala.co/developers/reference/#exit-11)

API commands share the CLI’s HTTP error mapping. [Read human and JSON output rules](https://recala.co/developers/reference/#json-output).
