# Rules and schedules

Generated from `--help` output of fob-actual 0.1.0. Every command also accepts the global options `--profile <name>`, `--help` and `--version`.

## rules

### rules list

```text
fob-actual rules list

List import rules

Options:
      --limit   Maximum rows to show                                                        [number]
      --json    Output raw JSON                                                            [boolean]
      --fields  Columns to show, comma-separated                                            [string]
      --format  Output format                             [string] [choices: "table", "csv", "json"]
      --output  Write output to a file instead of stdout                                    [string]
      --payee   Only rules for this payee id                                                [string]
```

### rules show

```text
fob-actual rules show <id>

Show one rule with its conditions and actions

Positionals:
  id  Rule id                                                                    [string] [required]

Options:
      --json  Output raw JSON                                                              [boolean]
```

### rules create

```text
fob-actual rules create

Create a rule from JSON

Options:
      --dry-run  Show what would change without writing                                    [boolean]
      --json     Output raw JSON                                                           [boolean]
      --rule     Rule as a JSON string                                                      [string]
      --file     Read the rule JSON from a file                                             [string]
```

### rules edit

```text
fob-actual rules edit <id>

Replace a rule from JSON

Positionals:
  id  Rule id                                                                    [string] [required]

Options:
      --dry-run  Show what would change without writing                                    [boolean]
      --json     Output raw JSON                                                           [boolean]
      --rule     Rule as a JSON string                                                      [string]
      --file     Read the rule JSON from a file                                             [string]
```

### rules delete

```text
fob-actual rules delete <id>

Delete a rule (requires --yes)

Positionals:
  id  Rule id                                                                    [string] [required]

Options:
      --dry-run  Show what would change without writing                                    [boolean]
      --json     Output raw JSON                                                           [boolean]
  -y, --yes      Confirm deletion                                                          [boolean]
```

## schedules

### schedules list

```text
fob-actual schedules list

List scheduled transactions

Options:
      --limit   Maximum rows to show                                                        [number]
      --json    Output raw JSON                                                            [boolean]
      --fields  Columns to show, comma-separated                                            [string]
      --format  Output format                             [string] [choices: "table", "csv", "json"]
      --output  Write output to a file instead of stdout                                    [string]
      --all     Include completed schedules                                                [boolean]
```

### schedules show

```text
fob-actual schedules show <id>

Show one schedule

Positionals:
  id  Schedule id                                                                [string] [required]

Options:
      --json  Output raw JSON                                                              [boolean]
```

### schedules create

```text
fob-actual schedules create

Create a schedule from JSON

Options:
      --dry-run   Show what would change without writing                                   [boolean]
      --json      Output raw JSON                                                          [boolean]
      --schedule  Schedule as a JSON string                                                 [string]
      --file      Read the schedule JSON from a file                                        [string]
```

### schedules edit

```text
fob-actual schedules edit <id>

Update a schedule (only passed fields change)

Positionals:
  id  Schedule id                                                                [string] [required]

Options:
      --dry-run          Show what would change without writing                            [boolean]
      --json             Output raw JSON                                                   [boolean]
      --schedule         Schedule as a JSON string                                          [string]
      --file             Read the schedule JSON from a file                                 [string]
      --name             Schedule name                                                      [string]
      --amount           Amount, e.g. -1200.00                                              [string]
      --completed        Mark completed                                                    [boolean]
      --reset-next-date  Recompute the next occurrence                                     [boolean]
```

### schedules delete

```text
fob-actual schedules delete <id>

Delete a schedule (requires --yes)

Positionals:
  id  Schedule id                                                                [string] [required]

Options:
      --dry-run  Show what would change without writing                                    [boolean]
      --json     Output raw JSON                                                           [boolean]
  -y, --yes      Confirm deletion                                                          [boolean]
```