diff --git a/docs/guides/using-slack-cli-with-bolt-frameworks.md b/docs/guides/using-slack-cli-with-bolt-frameworks.md index 1b342795..779f279a 100644 --- a/docs/guides/using-slack-cli-with-bolt-frameworks.md +++ b/docs/guides/using-slack-cli-with-bolt-frameworks.md @@ -6,6 +6,12 @@ sidebar_label: Using with Bolt frameworks You can use the Slack CLI to streamline development of apps using [Bolt for JavaScript](/tools.slack.dev/bolt-js) and [Bolt for Python](/tools.slack.dev/bolt-python). +:::info + +To create a Bolt app using features currently under development, refer to the [experiments](https://tools.slack.dev/slack-cli/reference/experiments) page. + +::: + ## Getting started Creating a Bolt app via the Slack CLI is similar to creating other apps with the Slack CLI. Run the following command to begin: @@ -26,7 +32,7 @@ View more samples You will then be prompted to choose between **Bolt for JavaScript** or **Bolt for Python**. Choose your favorite flavor. -Your app will be cloned from the respective [JavaScript](https://github.com/slack-samples/bolt-js-starter-template) or [Python](https://github.com/slack-samples/bolt-python-starter-template) project template on our Slack Platform Sample Code repository, and its project dependencies will be installed. Then, `cd` into your project folder. +Your app will be cloned from the respective [JavaScript](https://github.com/slack-samples/bolt-js-starter-template) or [Python](https://github.com/slack-samples/bolt-python-starter-template) project template on our Slack Platform Sample Code repository, and its project dependencies will be installed. Then, `cd` into your project folder. :::info @@ -34,10 +40,10 @@ For Bolt for Python projects, automatic project dependency installation is curre ::: -To run your new app, use the `slack run` command as follows: +To run your new app, use the `slack run` command with the experiment flag as follows: ``` slack run ``` -You'll be prompted to choose your team/workspace, and then your app should let you know that it's up and running. 🎉 +You'll be prompted to choose your team/workspace, and then your app should let you know that it's up and running. 🎉 \ No newline at end of file diff --git a/docs/reference/experiments.md b/docs/reference/experiments.md index 06f6e934..088b6ef1 100644 --- a/docs/reference/experiments.md +++ b/docs/reference/experiments.md @@ -1,11 +1,24 @@ # Experiments -The Slack CLI has an experiment flag, behind which we put features under development and may cause breaking changes. These features are fleeting and many will not work without a development instance, but are available for use "at your own risk." +The Slack CLI has an experiment (`-e`) flag behind which we put features currently under development. These features may be fleeting, may not be perfectly polished, and many will not work without a development instance - but we have made them available for use "at your own risk." ## Available experiments -The following is a list of currently available experiments. We may remove an experiment once the feature is released. +The following is a list of currently available experiments. We'll remove experiments from this page if we decide they are no longer needed or once they are released, in which case we'll make an announcement about the feature's general availability in the [developer changelog](https://docs.slack.dev/changelog). * `bolt-install`: enables creating, installing, and running Bolt projects that manage their app manifest on app settings (remote manifest). * `slack create` and `slack init` now set manifest source to "app settings" (remote) for Bolt JS & Bolt Python projects ([PR#96](https://github.com/slackapi/slack-cli/pull/96)). * `read-only-collaborators`: enables creating and modifying collaborator permissions via the `slack collaborator` commands. + +## Experiments changelog + +Below is a list of updates related to experiments. + +* **May 2025**: Added the experiment `experiment bolt-install` to enable creating, installing, and running Bolt projects that manage their app manifest on app settings (remote manifest). +* **February 2025**: Added full Bolt framework support to the Slack CLI and removed the features from behind the experiment flag. See the changelog announcement [here](https://docs.slack.dev/changelog/2025/02/27/slack-cli-release). +* **August 2024**: Added the `bolt` experiment for the `slack create` command. +* **January 2024**: Added the experiment `read-only-collaborators`. + +## Feedback + +We love feedback from our community, so we encourage you to explore and interact with the [GitHub repo](https://github.com/slackapi/slack-cli). Contributions, bug reports, and any feedback are all helpful; let us nurture the Slack CLI together to help make building Slack apps more pleasant for everyone.