You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Slack CLI](https://api.slack.com/automation/cli/install) and
5
12
[Bolt for Python](https://slack.dev/bolt-python/).
6
13
7
14
## Overview
8
-
This library enables inter-process communication between the [Slack CLI](https://api.slack.com/automation/cli/install) and applications built with Bolt for Python.
9
15
10
-
When used together, the CLI delegates various tasks to the Bolt application by invoking processes ("hooks") and then making use of the responses provided by each hook's `stdout`.
16
+
This library enables inter-process communication between the [Slack CLI](https://api.slack.com/automation/cli/install) and applications built with Bolt for Python.
17
+
18
+
When used together, the CLI delegates various tasks to the Bolt application by invoking processes ("hooks") and then making use of the responses provided by each hook's `stdout`.
11
19
12
20
For a complete list of available hooks, read the [Supported Hooks](#supported-hooks) section.
13
21
14
22
## Requirements
23
+
15
24
The latest minor version of [Bolt v1](https://pypi.org/project/slack-bolt/) is recommended.
16
25
17
26
## Usage
27
+
18
28
A Slack CLI-compatible Slack application includes a `./slack.json` file that contains hooks specific to that project. Each hook is associated with commands that are available in the Slack CLI. By default, `get-hooks` retrieves all of the [supported hooks](#supported-hooks) and their corresponding scripts as defined in this library.
19
29
20
30
The CLI will always use the version of the `python-slack-hooks` that is specified in the project's `requirements.txt`.
@@ -30,15 +40,15 @@ The hooks currently supported for use within the Slack CLI include `check-update
30
40
|`get-manifest`|`slack manifest`|[get_manifest.py](./slack_cli_hooks/hooks/get_manifest.py)| Converts a `manifest.json` file into a valid manifest JSON payload. |
31
41
|`start`|`slack run`|[start.py](./slack_cli_hooks/hooks/start.py)| While developing locally, the CLI manages a socket connection with Slack's backend and utilizes this hook for events received via this connection. |
32
42
33
-
34
43
### Overriding Hooks
35
-
To customize the behavior of a hook, add the hook to your application's `/slack.json` file, and provide a corresponding script to be executed.
44
+
45
+
To customize the behavior of a hook, add the hook to your application's `/slack.json` file, and provide a corresponding script to be executed.
36
46
37
47
When commands are run, the Slack CLI will look to the project's hook definitions and use those instead of what's defined in this library, if provided.
38
48
39
49
Below is an example `/slack.json` file that overrides the default `start`:
0 commit comments