Skip to content

Commit d115165

Browse files
committed
update docs
1 parent fd32c75 commit d115165

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

docs/guide/executable.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,27 @@ For instance, `flow test my-app` is equivalent to `flow validate my-app`. This a
4141
interaction with the CLI, making it easier to remember and use.
4242
*See the [verb reference](../types/flowfile.md#verb-groups) for a list all verbs and their synonyms.*
4343

44+
**Custom Verb Aliases**
45+
46+
You can customize which verb aliases are available in your workspace by configuring `verbAliases` in your [workspace configuration](workspace.md#workspace-configuration). This allows you to:
47+
48+
- **Use custom aliases**: Define your own preferred aliases for verbs
49+
- **Disable default aliases**: Set an empty map `{}` to disable all verb aliases
50+
- **Selective aliases**: Only enable specific aliases for certain verbs
51+
52+
```yaml
53+
# In your workspace flow.yaml
54+
verbAliases:
55+
run: ["exec", "start"] # `run` executables can be called with `exec` or `start`
56+
build: ["compile"] # `build` executables can be called with `compile`
57+
# No entry for `test` means no aliases for test executables
58+
59+
# To disable all verb aliases:
60+
verbAliases: {}
61+
```
62+
63+
With the above configuration, `flow start my-app` would run a `run` executable, but `flow execute my-app` would fail because `execute` is no longer a valid alias.
64+
4465
> [!TIP]
4566
> Create shell aliases for commonly used verbs to make running executables easier. For example:
4667
> ```shell

docs/guide/workspace.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,27 @@ When a workspace is created, a [configuration](#workspace-configuration) file is
1818

1919
The workspace configuration file is a YAML file that contains the configuration options for the workspace. This file is located in the root directory of the workspace and is named `flow.yaml`.
2020

21+
```yaml
22+
# Example workspace configuration
23+
displayName: "My Project"
24+
description: "A sample Flow workspace"
25+
descriptionFile: README.md
26+
tags: ["development", "web"]
27+
verbAliases:
28+
run: ["exec", "start"]
29+
build: ["compile"]
30+
executables:
31+
included: ["scripts/", "tools/"]
32+
excluded: ["node_modules/", ".git/"]
33+
```
34+
35+
**Key Configuration Options:**
36+
37+
- **verbAliases**: Customize which verb aliases are available when running executables. Set to `{}` to disable all aliases. See [custom verb aliases](executable.md#custom-verb-aliases) for more details.
38+
- **executables**: Configure which directories to include or exclude when discovering executables.
39+
- **displayName**, **description**, and **descriptionFile**: Used in the interactive UI and library views.
40+
- **tags**: Used for filtering workspaces.
41+
2142
For more details about workspace configuration options, see [Workspace](../types/workspace.md).
2243

2344

0 commit comments

Comments
 (0)