Skip to content

Commit

Permalink
docs: update compile commands in README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Vladislav Doster <[email protected]>
  • Loading branch information
vladdoster committed Mar 4, 2024
1 parent 688fc62 commit e5e9148
Showing 1 changed file with 38 additions and 5 deletions.
43 changes: 38 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@
- [Tracking of the Active Session](#tracking-of-the-active-session)
- [Reports and Statistics](#reports-and-statistics)
- [Compiling](#compiling)
- [compile](#compile)
- [compiled](#compiled)
- [uncompile](#uncompile)
- [Other](#other)
- [Updating Zinit and Plugins](#updating-zinit-and-plugins)
- [Completions](#completions-2)
Expand Down Expand Up @@ -853,11 +856,41 @@ Following commands are passed to `zinit ...` to obtain described effects.

### Compiling<a name="compiling"></a>

| Command | Description |
| ---------------------- | ------------------------------------------------------------------- |
| `compiled` | List plugins that are compiled. |
| `compile {plg-spec}` | Compile plugin. `--all` – compile all plugins. |
| `uncompile {plg-spec}` | Remove compiled version of plugin. `--all` – do it for all plugins. |
#### compile<a name="compile"></a>

List plugins that are compiled.

```zsh
zinit [options] compile PLUGIN
```

| Option | Description |
| ------------- | ------------------------- |
| `-a, --all` | Compile all plugins |
| `-h, --help` | Print usage |
| `-q, --quiet` | Suppress the build output |

#### compiled<a name="compiled"></a>

List plugins that are compiled.

```zsh
zinit compiled
```

#### uncompile<a name="uncompile"></a>

List plugins that are compiled.

```zsh
zinit [options] uncompile PLUGIN
```

| Option | Description |
| ------------- | ----------------------------------------- |
| `-a, --all` | Remove any compiled files for all plugins |
| `-h, --help` | Print usage |
| `-q, --quiet` | Suppress the output |

### Other<a name="other"></a>

Expand Down

0 comments on commit e5e9148

Please sign in to comment.