Skip to content

docs: add Slack CLI setup instructions to README#23

Merged
srtaalej merged 2 commits into
mainfrom
add-slack-cli-instructions
May 15, 2026
Merged

docs: add Slack CLI setup instructions to README#23
srtaalej merged 2 commits into
mainfrom
add-slack-cli-instructions

Conversation

@srtaalej

Copy link
Copy Markdown
Contributor

Summary

  • Adds collapsible "Using Slack CLI" section with install, login, create, and install commands
  • Wraps existing manual setup in a collapsible "Using Terminal" section
  • Adds a Development section with slack run and npm start options
  • Matches the pattern used by bolt-js-assistant-template and bolt-js-search-template

Test plan

  • Verify rendered README displays both collapsible sections correctly
  • Confirm CLI commands reference the correct template repo name

@srtaalej srtaalej requested a review from a team as a code owner May 12, 2026 19:05
@srtaalej srtaalej self-assigned this May 12, 2026
@srtaalej srtaalej added documentation Improvements or additions to documentation enhancement New feature or request labels May 12, 2026

@zimeg zimeg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@srtaalej 📚 ✨ LGTM! Fastest setups with a blank template are good for times ahead I hope!

Comment thread README.md
Comment on lines +22 to +27
You'll also need to log in if this is your first time using the Slack CLI.

```sh
slack login
```

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🪓 note: Same changes for slack-samples/bolt-python-starter-template#80

Comment thread README.md Outdated
Comment on lines +35 to +44
#### Creating the Slack app

Use the following command to add your new Slack app to your development workspace. Choose a "local" app environment for upcoming development:

```sh
slack install
```

After the Slack app has been created you're all set to start developing!

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Creating the Slack app
Use the following command to add your new Slack app to your development workspace. Choose a "local" app environment for upcoming development:
```sh
slack install
```
After the Slack app has been created you're all set to start developing!

🪓 note: Am hoping this is the right amount of text to suggest removing?

@srtaalej srtaalej merged commit d18ad10 into main May 15, 2026
5 checks passed
@srtaalej srtaalej deleted the add-slack-cli-instructions branch May 15, 2026 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants