Skip to content

Commit

Permalink
Add first draft of "Available commands" page
Browse files Browse the repository at this point in the history
  • Loading branch information
jkniest committed Jun 16, 2024
1 parent ea330a9 commit 58d7e7f
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions docs/writing/available-commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Available commands

The fixture plugin provides a few [symfony commands](#todo) you can execute.

## Running fixtures
### Run all fixtures
```shell:no-line-numbers
bin/console fixture:load
```

Possible arguments:
| Argument | Description | Default Value |
| -------- | ---------------------------------------------------------- | ------------- |
| --dry | Display all fixtures that would run without executing them | false |
| --vendor | Execute also all fixtures found in the vendor directory | false |

### Run a specific fixture
```shell:no-line-numbers
bin/console fixture:load:single {FixtureName}
```

Possible arguments:
| Argument | Description | Default Value |
| ------------------- | ---------------------------------------------------------- | ------------- |
| --dry | Display all fixtures that would run without executing them | false |
| --vendor | Execute also all fixtures found in the vendor directory | false |
| --with-dependencies | Also execute all dependencies recursively | false |
| -w | Alias for `--with-dependencies` | false |

### Run a fixture group
```shell:no-line-numbers
bin/console fixture:load:group {GroupName}
```

Possible arguments:
| Argument | Description | Default Value |
| -------- | ---------------------------------------------------------- | ------------- |
| --dry | Display all fixtures that would run without executing them | false |
| --vendor | Execute also all fixtures found in the vendor directory | false |

## Helper commands
### Get random UUID
```shell:no-line-numbers
bin/console fixture:uuid
```

This command just returns a valid, random UUID.

0 comments on commit 58d7e7f

Please sign in to comment.