diff --git a/docs/reference/commands/slack.md b/docs/reference/commands/slack.md index 0bb3f6c4..4c192e38 100644 --- a/docs/reference/commands/slack.md +++ b/docs/reference/commands/slack.md @@ -1,18 +1,18 @@ -## slack +# `slack` Slack command-line tool -### Synopsis +## Synopsis CLI to create, run, and deploy Slack apps -Get started by reading the docs: [https://tools.slack.dev/deno-slack-sdk](/deno-slack-sdk) +Get started by reading the docs: [https://tools.slack.dev/slack-cli](https://tools.slack.dev/slack-cli) ``` slack [flags] ``` -### Examples +## Examples ``` $ slack login # Log in to your Slack account @@ -22,7 +22,7 @@ $ slack run # Start a local development server $ slack deploy # Deploy to the Slack Platform ``` -### Options +## Options ``` -a, --app string use a specific app ID or environment @@ -37,7 +37,7 @@ $ slack deploy # Deploy to the Slack Platform -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack activity](slack_activity) - Display the app activity logs from the Slack Platform * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_activity.md b/docs/reference/commands/slack_activity.md index ea23f642..b46104f5 100644 --- a/docs/reference/commands/slack_activity.md +++ b/docs/reference/commands/slack_activity.md @@ -1,8 +1,8 @@ -## slack activity +# `slack activity` Display the app activity logs from the Slack Platform -### Synopsis +## Synopsis Display the app activity logs from the Slack Platform @@ -10,14 +10,14 @@ Display the app activity logs from the Slack Platform slack activity [flags] ``` -### Examples +## Examples ``` $ slack platform activity # Display app activity logs for an app $ slack platform activity -t # Continuously poll for new activity logs ``` -### Options +## Options ``` --component string component type to filter @@ -40,7 +40,7 @@ $ slack platform activity -t # Continuously poll for new activity logs --trace-id string trace id to filter ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -54,7 +54,7 @@ $ slack platform activity -t # Continuously poll for new activity logs -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_app.md b/docs/reference/commands/slack_app.md index acdbd450..1083f672 100644 --- a/docs/reference/commands/slack_app.md +++ b/docs/reference/commands/slack_app.md @@ -1,8 +1,8 @@ -## slack app +# `slack app` Install, uninstall, and list teams with the app installed -### Synopsis +## Synopsis Install, uninstall, and list teams with the app installed @@ -10,23 +10,24 @@ Install, uninstall, and list teams with the app installed slack app [flags] ``` -### Examples +## Examples ``` -$ slack install # Install a production app to a team -$ slack link # Link an existing app to the project -$ slack list # List all teams with the app installed -$ slack uninstall # Uninstall an app from a team -$ slack delete # Delete an app and app info from a team +$ slack app install # Install a production app to a team +$ slack app link # Link an existing app to the project +$ slack app list # List all teams with the app installed +$ slack app settings # Open app settings in a web browser +$ slack app uninstall # Uninstall an app from a team +$ slack app delete # Delete an app and app info from a team ``` -### Options +## Options ``` -h, --help help for app ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -40,12 +41,13 @@ $ slack delete # Delete an app and app info from a team -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack app delete](slack_app_delete) - Delete the app * [slack app install](slack_app_install) - Install the app to a team * [slack app link](slack_app_link) - Add an existing app to the project * [slack app list](slack_app_list) - List teams with the app installed +* [slack app settings](slack_app_settings) - Open app settings for configurations * [slack app uninstall](slack_app_uninstall) - Uninstall the app from a team diff --git a/docs/reference/commands/slack_app_delete.md b/docs/reference/commands/slack_app_delete.md index 8abd4aa1..1cc5986a 100644 --- a/docs/reference/commands/slack_app_delete.md +++ b/docs/reference/commands/slack_app_delete.md @@ -1,8 +1,8 @@ -## slack app delete +# `slack app delete` Delete the app -### Synopsis +## Synopsis Uninstall the app from the team and permanently delete the app and all of its data @@ -10,7 +10,7 @@ Uninstall the app from the team and permanently delete the app and all of its da slack app delete [flags] ``` -### Examples +## Examples ``` # Delete an app and app info from a team @@ -20,13 +20,13 @@ $ slack app delete $ slack app delete --team T0123456 --app local ``` -### Options +## Options ``` -h, --help help for delete ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -40,7 +40,7 @@ $ slack app delete --team T0123456 --app local -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_install.md b/docs/reference/commands/slack_app_install.md index b0d3e293..e8d27536 100644 --- a/docs/reference/commands/slack_app_install.md +++ b/docs/reference/commands/slack_app_install.md @@ -1,8 +1,8 @@ -## slack app install +# `slack app install` Install the app to a team -### Synopsis +## Synopsis Install the app to a team @@ -10,7 +10,7 @@ Install the app to a team slack app install [flags] ``` -### Examples +## Examples ``` $ slack app install # Install a production app to a team @@ -19,7 +19,7 @@ $ slack app install # Install a production app to a team $ slack app install --team T0123456 ``` -### Options +## Options ``` -h, --help help for install @@ -27,7 +27,7 @@ $ slack app install --team T0123456 (or 'all' for all workspaces in the org) ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -41,7 +41,7 @@ $ slack app install --team T0123456 -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_link.md b/docs/reference/commands/slack_app_link.md index 491046f1..848059c4 100644 --- a/docs/reference/commands/slack_app_link.md +++ b/docs/reference/commands/slack_app_link.md @@ -1,8 +1,8 @@ -## slack app link +# `slack app link` Add an existing app to the project -### Synopsis +## Synopsis Saves an existing app to a project to be available to other commands. @@ -19,7 +19,7 @@ Only one app can exist for each combination of Team ID and environment. slack app link [flags] ``` -### Examples +## Examples ``` # Add an existing app to a project @@ -29,14 +29,14 @@ $ slack app link $ slack app link --team T0123456789 --app A0123456789 --environment deployed ``` -### Options +## Options ``` -E, --environment string environment to save existing app (local, deployed) -h, --help help for link ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -50,7 +50,7 @@ $ slack app link --team T0123456789 --app A0123456789 --environment deployed -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_list.md b/docs/reference/commands/slack_app_list.md index 3ce1de2b..452d4ab2 100644 --- a/docs/reference/commands/slack_app_list.md +++ b/docs/reference/commands/slack_app_list.md @@ -1,8 +1,8 @@ -## slack app list +# `slack app list` List teams with the app installed -### Synopsis +## Synopsis List all teams that have installed the app @@ -10,13 +10,13 @@ List all teams that have installed the app slack app list [flags] ``` -### Examples +## Examples ``` $ slack app list # List all teams with the app installed ``` -### Options +## Options ``` --all-org-workspace-grants display all workspace grants for an app @@ -24,7 +24,7 @@ $ slack app list # List all teams with the app installed -h, --help help for list ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack app list # List all teams with the app installed -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_app_settings.md b/docs/reference/commands/slack_app_settings.md new file mode 100644 index 00000000..58895fab --- /dev/null +++ b/docs/reference/commands/slack_app_settings.md @@ -0,0 +1,51 @@ +# `slack app settings` + +Open app settings for configurations + +## Synopsis + +Open app settings to configure an application in a web browser. + +Discovering new features and customizing an app manifest can be done from this +web interface for apps with a "remote" manifest source. + +This command does not support apps deployed to Run on Slack infrastructure. + +``` +slack app settings [flags] +``` + +## Examples + +``` +# Open app settings for a prompted app +$ slack app settings + +# Open app settings for a specific app +$ slack app settings --app A0123456789 +``` + +## Options + +``` + -h, --help help for settings +``` + +## Options inherited from parent commands + +``` + -a, --app string use a specific app ID or environment + --config-dir string use a custom path for system config directory + -e, --experiment strings use the experiment(s) in the command + -f, --force ignore warnings and continue executing command + --no-color remove styles and formatting from outputs + -s, --skip-update skip checking for latest version of CLI + -w, --team string select workspace or organization by team name or ID + --token string set the access token associated with a team + -v, --verbose print debug logging and additional info +``` + +## SEE ALSO + +* [slack app](slack_app) - Install, uninstall, and list teams with the app installed + diff --git a/docs/reference/commands/slack_app_uninstall.md b/docs/reference/commands/slack_app_uninstall.md index 4554f008..dea27a0d 100644 --- a/docs/reference/commands/slack_app_uninstall.md +++ b/docs/reference/commands/slack_app_uninstall.md @@ -1,8 +1,8 @@ -## slack app uninstall +# `slack app uninstall` Uninstall the app from a team -### Synopsis +## Synopsis Uninstall the app from a team without deleting the app or its data @@ -10,19 +10,19 @@ Uninstall the app from a team without deleting the app or its data slack app uninstall [flags] ``` -### Examples +## Examples ``` $ slack app uninstall # Uninstall an app from a team ``` -### Options +## Options ``` -h, --help help for uninstall ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,7 +36,7 @@ $ slack app uninstall # Uninstall an app from a team -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack app](slack_app) - Install, uninstall, and list teams with the app installed diff --git a/docs/reference/commands/slack_auth.md b/docs/reference/commands/slack_auth.md index e5572af4..112c9fef 100644 --- a/docs/reference/commands/slack_auth.md +++ b/docs/reference/commands/slack_auth.md @@ -1,8 +1,8 @@ -## slack auth +# `slack auth` Add and remove local team authorizations -### Synopsis +## Synopsis Add and remove local team authorizations @@ -10,7 +10,7 @@ Add and remove local team authorizations slack auth [flags] ``` -### Examples +## Examples ``` $ slack auth list # List all authorized accounts @@ -18,13 +18,13 @@ $ slack auth login # Log in to a Slack account $ slack auth logout # Log out of a team ``` -### Options +## Options ``` -h, --help help for auth ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack auth logout # Log out of a team -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack auth list](slack_auth_list) - List all authorized accounts diff --git a/docs/reference/commands/slack_auth_list.md b/docs/reference/commands/slack_auth_list.md index a0a8f6f5..42f18c02 100644 --- a/docs/reference/commands/slack_auth_list.md +++ b/docs/reference/commands/slack_auth_list.md @@ -1,8 +1,8 @@ -## slack auth list +# `slack auth list` List all authorized accounts -### Synopsis +## Synopsis List all authorized accounts @@ -10,19 +10,19 @@ List all authorized accounts slack auth list [flags] ``` -### Examples +## Examples ``` $ slack auth list # List all authorized accounts ``` -### Options +## Options ``` -h, --help help for list ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,7 +36,7 @@ $ slack auth list # List all authorized accounts -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_login.md b/docs/reference/commands/slack_auth_login.md index bb481242..cfe277ce 100644 --- a/docs/reference/commands/slack_auth_login.md +++ b/docs/reference/commands/slack_auth_login.md @@ -1,8 +1,8 @@ -## slack auth login +# `slack auth login` Log in to a Slack account -### Synopsis +## Synopsis Log in to a Slack account in your team @@ -10,7 +10,7 @@ Log in to a Slack account in your team slack auth login [flags] ``` -### Examples +## Examples ``` # Login to a Slack account with prompts @@ -26,7 +26,7 @@ $ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... $ slack auth login --token xoxp-... ``` -### Options +## Options ``` --challenge string provide a challenge code for pre-authenticated login @@ -36,7 +36,7 @@ $ slack auth login --token xoxp-... --token string provide a token for a pre-authenticated login ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -49,7 +49,7 @@ $ slack auth login --token xoxp-... -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_logout.md b/docs/reference/commands/slack_auth_logout.md index c45731eb..c266d9a8 100644 --- a/docs/reference/commands/slack_auth_logout.md +++ b/docs/reference/commands/slack_auth_logout.md @@ -1,8 +1,8 @@ -## slack auth logout +# `slack auth logout` Log out of a team -### Synopsis +## Synopsis Log out of a team, removing any local credentials @@ -10,21 +10,21 @@ Log out of a team, removing any local credentials slack auth logout [flags] ``` -### Examples +## Examples ``` $ slack auth logout # Select a team to log out of $ slack auth logout --all # Log out of all team ``` -### Options +## Options ``` -A, --all logout of all workspaces -h, --help help for logout ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack auth logout --all # Log out of all team -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_revoke.md b/docs/reference/commands/slack_auth_revoke.md index 7181b48a..5e630c0f 100644 --- a/docs/reference/commands/slack_auth_revoke.md +++ b/docs/reference/commands/slack_auth_revoke.md @@ -1,8 +1,8 @@ -## slack auth revoke +# `slack auth revoke` Revoke an authentication token -### Synopsis +## Synopsis Revoke an authentication token @@ -10,19 +10,19 @@ Revoke an authentication token slack auth revoke [flags] ``` -### Examples +## Examples ``` $ slack auth revoke --token xoxp-1-4921830... # Revoke a service token ``` -### Options +## Options ``` -h, --help help for revoke ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,7 +36,7 @@ $ slack auth revoke --token xoxp-1-4921830... # Revoke a service token -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_auth_token.md b/docs/reference/commands/slack_auth_token.md index ccc99d23..ed4c00eb 100644 --- a/docs/reference/commands/slack_auth_token.md +++ b/docs/reference/commands/slack_auth_token.md @@ -1,8 +1,8 @@ -## slack auth token +# `slack auth token` Collect a service token -### Synopsis +## Synopsis Log in to a Slack account in your team @@ -10,7 +10,7 @@ Log in to a Slack account in your team slack auth token [flags] ``` -### Examples +## Examples ``` # Create a service token with prompts @@ -23,7 +23,7 @@ $ slack auth token --no-prompt $ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... ``` -### Options +## Options ``` --challenge string provide a challenge code for pre-authenticated login @@ -32,7 +32,7 @@ $ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... --ticket string provide an auth ticket value ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -46,7 +46,7 @@ $ slack auth token --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack auth](slack_auth) - Add and remove local team authorizations diff --git a/docs/reference/commands/slack_collaborator.md b/docs/reference/commands/slack_collaborator.md index 25f8c9fb..d7059428 100644 --- a/docs/reference/commands/slack_collaborator.md +++ b/docs/reference/commands/slack_collaborator.md @@ -1,8 +1,8 @@ -## slack collaborator +# `slack collaborator` Manage app collaborators -### Synopsis +## Synopsis Manage app collaborators @@ -10,7 +10,7 @@ Manage app collaborators slack collaborator [flags] ``` -### Examples +## Examples ``` $ slack collaborator add bots@slack.com # Add a collaborator from email @@ -20,13 +20,13 @@ $ slack collaborator list # List all of the collaborators $ slack collaborator remove USLACKBOT ``` -### Options +## Options ``` -h, --help help for collaborator ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -40,7 +40,7 @@ $ slack collaborator remove USLACKBOT -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack collaborator add](slack_collaborator_add) - Add a new collaborator to the app diff --git a/docs/reference/commands/slack_collaborator_add.md b/docs/reference/commands/slack_collaborator_add.md index 24f0a3e8..b175ac0b 100644 --- a/docs/reference/commands/slack_collaborator_add.md +++ b/docs/reference/commands/slack_collaborator_add.md @@ -1,8 +1,8 @@ -## slack collaborator add +# `slack collaborator add` Add a new collaborator to the app -### Synopsis +## Synopsis Add a collaborator to your app by Slack email address or user ID @@ -10,7 +10,7 @@ Add a collaborator to your app by Slack email address or user ID slack collaborator add [email|user_id] [flags] ``` -### Examples +## Examples ``` $ slack collaborator add # Add a collaborator via prompt @@ -18,13 +18,13 @@ $ slack collaborator add bot@slack.com # Add a collaborator from email $ slack collaborator add USLACKBOT # Add a collaborator by user ID ``` -### Options +## Options ``` -h, --help help for add ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack collaborator add USLACKBOT # Add a collaborator by user ID -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_collaborator_list.md b/docs/reference/commands/slack_collaborator_list.md index 26a737f5..d1282beb 100644 --- a/docs/reference/commands/slack_collaborator_list.md +++ b/docs/reference/commands/slack_collaborator_list.md @@ -1,8 +1,8 @@ -## slack collaborator list +# `slack collaborator list` List all collaborators of an app -### Synopsis +## Synopsis List all collaborators of an app @@ -10,19 +10,19 @@ List all collaborators of an app slack collaborator list [flags] ``` -### Examples +## Examples ``` $ slack collaborator list # List all of the collaborators ``` -### Options +## Options ``` -h, --help help for list ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,7 +36,7 @@ $ slack collaborator list # List all of the collaborators -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_collaborator_remove.md b/docs/reference/commands/slack_collaborator_remove.md index b9714bbe..7aeeea9a 100644 --- a/docs/reference/commands/slack_collaborator_remove.md +++ b/docs/reference/commands/slack_collaborator_remove.md @@ -1,8 +1,8 @@ -## slack collaborator remove +# `slack collaborator remove` Remove a collaborator from an app -### Synopsis +## Synopsis Remove a collaborator from an app by Slack email address or user ID @@ -10,7 +10,7 @@ Remove a collaborator from an app by Slack email address or user ID slack collaborator remove [email|user_id] [flags] ``` -### Examples +## Examples ``` $ slack collaborator remove # Remove collaborator on prompt @@ -18,13 +18,13 @@ $ slack collaborator remove bot@slack.com # Remove collaborator by email $ slack collaborator remove USLACKBOT # Remove collaborator using ID ``` -### Options +## Options ``` -h, --help help for remove ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack collaborator remove USLACKBOT # Remove collaborator using ID -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack collaborator](slack_collaborator) - Manage app collaborators diff --git a/docs/reference/commands/slack_create.md b/docs/reference/commands/slack_create.md index 7c65ccc2..a8b1add5 100644 --- a/docs/reference/commands/slack_create.md +++ b/docs/reference/commands/slack_create.md @@ -1,8 +1,8 @@ -## slack create +# `slack create` Create a new Slack project -### Synopsis +## Synopsis Create a new Slack project on your local machine from an optional template @@ -10,7 +10,7 @@ Create a new Slack project on your local machine from an optional template slack create [name] [flags] ``` -### Examples +## Examples ``` # Create a new project from a template @@ -20,7 +20,7 @@ $ slack create my-project $ slack create my-project -t slack-samples/deno-hello-world ``` -### Options +## Options ``` -b, --branch string name of git branch to checkout @@ -28,7 +28,7 @@ $ slack create my-project -t slack-samples/deno-hello-world -t, --template string template URL for your app ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -42,7 +42,7 @@ $ slack create my-project -t slack-samples/deno-hello-world -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_datastore.md b/docs/reference/commands/slack_datastore.md index b25b08a6..b1f7cf00 100644 --- a/docs/reference/commands/slack_datastore.md +++ b/docs/reference/commands/slack_datastore.md @@ -1,8 +1,8 @@ -## slack datastore +# `slack datastore` Interact with an app's datastore -### Synopsis +## Synopsis Interact with the items stored in an app's datastore. @@ -15,7 +15,7 @@ Discover the datastores: [https://tools.slack.dev/deno-slack-sdk/guides/using-da slack datastore [flags] ``` -### Examples +## Examples ``` # Add a new entry to the datastore @@ -46,13 +46,13 @@ $ slack datastore query --datastore tasks '{"expression": "#status = :status", " $ slack datastore count --datastore tasks ``` -### Options +## Options ``` -h, --help help for datastore ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -66,7 +66,7 @@ $ slack datastore count --datastore tasks -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack datastore bulk-delete](slack_datastore_bulk-delete) - Delete multiple items from a datastore diff --git a/docs/reference/commands/slack_datastore_bulk-delete.md b/docs/reference/commands/slack_datastore_bulk-delete.md index d0f237a8..b8c6bde5 100644 --- a/docs/reference/commands/slack_datastore_bulk-delete.md +++ b/docs/reference/commands/slack_datastore_bulk-delete.md @@ -1,8 +1,8 @@ -## slack datastore bulk-delete +# `slack datastore bulk-delete` Delete multiple items from a datastore -### Synopsis +## Synopsis Delete multiple items from a datastore. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-delete [flags] ``` -### Examples +## Examples ``` # Delete two items from the datastore @@ -23,7 +23,7 @@ $ slack datastore bulk-delete --datastore tasks '{"ids": ["12", "42"]}' $ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -32,7 +32,7 @@ $ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -46,7 +46,7 @@ $ slack datastore bulk-delete '{"datastore": "tasks", "ids": ["12", "42"]}' -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_bulk-get.md b/docs/reference/commands/slack_datastore_bulk-get.md index 9b6a5adc..f6406341 100644 --- a/docs/reference/commands/slack_datastore_bulk-get.md +++ b/docs/reference/commands/slack_datastore_bulk-get.md @@ -1,8 +1,8 @@ -## slack datastore bulk-get +# `slack datastore bulk-get` Get multiple items from a datastore -### Synopsis +## Synopsis Get multiple items from a datastore. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-get [flags] ``` -### Examples +## Examples ``` # Get two items from datastore @@ -23,7 +23,7 @@ $ slack datastore bulk-get --datastore tasks '{"ids": ["12", "42"]}' $ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -33,7 +33,7 @@ $ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,7 +47,7 @@ $ slack datastore bulk-get '{"datastore": "tasks", "ids": ["12", "42"]}' -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_bulk-put.md b/docs/reference/commands/slack_datastore_bulk-put.md index b6cbb4af..3c857609 100644 --- a/docs/reference/commands/slack_datastore_bulk-put.md +++ b/docs/reference/commands/slack_datastore_bulk-put.md @@ -1,8 +1,8 @@ -## slack datastore bulk-put +# `slack datastore bulk-put` Create or replace a list of items in a datastore -### Synopsis +## Synopsis Create or replace a list of items in a datastore. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore bulk-put [flags] ``` -### Examples +## Examples ``` # Create or replace two new entries in the datastore @@ -23,7 +23,7 @@ $ slack datastore bulk-put --datastore tasks '{"items": [{"id": "12", "descripti $ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "description": "Create a PR", "status": "Done"}, {"id": "42", "description": "Approve a PR", "status": "Pending"}]}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -33,7 +33,7 @@ $ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "descr --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,7 +47,7 @@ $ slack datastore bulk-put '{"datastore": "tasks", "items": [{"id": "12", "descr -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_count.md b/docs/reference/commands/slack_datastore_count.md index 55e4e342..f2528300 100644 --- a/docs/reference/commands/slack_datastore_count.md +++ b/docs/reference/commands/slack_datastore_count.md @@ -1,8 +1,8 @@ -## slack datastore count +# `slack datastore count` Count the number of items in a datastore -### Synopsis +## Synopsis Count the number of items in a datastore that match a query expression or just all of the items in the datastore. @@ -14,7 +14,7 @@ other apps can attempt to run the command with the --force flag. slack datastore count [expression] [flags] ``` -### Examples +## Examples ``` # Count all items in a datastore @@ -24,7 +24,7 @@ $ slack datastore count --datastore tasks $ slack datastore count '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -33,7 +33,7 @@ $ slack datastore count '{"datastore": "tasks", "expression": "#status = :status --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,7 +47,7 @@ $ slack datastore count '{"datastore": "tasks", "expression": "#status = :status -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_delete.md b/docs/reference/commands/slack_datastore_delete.md index ab62d6ba..34a66e0d 100644 --- a/docs/reference/commands/slack_datastore_delete.md +++ b/docs/reference/commands/slack_datastore_delete.md @@ -1,8 +1,8 @@ -## slack datastore delete +# `slack datastore delete` Delete an item from a datastore -### Synopsis +## Synopsis Delete an item from a datastore. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore delete [flags] ``` -### Examples +## Examples ``` # Remove an item from the datastore @@ -23,7 +23,7 @@ $ slack datastore delete --datastore tasks '{"id": "42"}' $ slack datastore delete '{"datastore": "tasks", "id": "42"}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -32,7 +32,7 @@ $ slack datastore delete '{"datastore": "tasks", "id": "42"}' --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -46,7 +46,7 @@ $ slack datastore delete '{"datastore": "tasks", "id": "42"}' -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_get.md b/docs/reference/commands/slack_datastore_get.md index b5ba4ba4..f79b8e5d 100644 --- a/docs/reference/commands/slack_datastore_get.md +++ b/docs/reference/commands/slack_datastore_get.md @@ -1,8 +1,8 @@ -## slack datastore get +# `slack datastore get` Get an item from a datastore -### Synopsis +## Synopsis Get an item from a datastore. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore get [flags] ``` -### Examples +## Examples ``` # Get an item from the datastore @@ -23,7 +23,7 @@ $ slack datastore get --datastore tasks '{"id": "42"}' $ slack datastore get '{"datastore": "tasks", "id": "42"}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -33,7 +33,7 @@ $ slack datastore get '{"datastore": "tasks", "id": "42"}' --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,7 +47,7 @@ $ slack datastore get '{"datastore": "tasks", "id": "42"}' -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_put.md b/docs/reference/commands/slack_datastore_put.md index 0b481950..ddda038e 100644 --- a/docs/reference/commands/slack_datastore_put.md +++ b/docs/reference/commands/slack_datastore_put.md @@ -1,8 +1,8 @@ -## slack datastore put +# `slack datastore put` Create or replace an item in a datastore -### Synopsis +## Synopsis Create or replace an item in a datastore. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore put [flags] ``` -### Examples +## Examples ``` # Add a new entry to the datastore @@ -23,7 +23,7 @@ $ slack datastore put --datastore tasks '{"item": {"id": "42", "description": "C $ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -32,7 +32,7 @@ $ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description" --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -46,7 +46,7 @@ $ slack datastore put '{"datastore": "tasks", "item": {"id": "42", "description" -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_query.md b/docs/reference/commands/slack_datastore_query.md index 1cfc767a..8ef5d003 100644 --- a/docs/reference/commands/slack_datastore_query.md +++ b/docs/reference/commands/slack_datastore_query.md @@ -1,8 +1,8 @@ -## slack datastore query +# `slack datastore query` Query a datastore for items -### Synopsis +## Synopsis Query a datastore for items. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore query [flags] ``` -### Examples +## Examples ``` # Collect a limited set of items from the datastore @@ -29,7 +29,7 @@ $ slack datastore query --datastore tasks '{"expression": "#status = :status", " $ slack datastore query '{"datastore": "tasks", "expression": "#status = :status", "expression_attributes": {"#status": "status"}, "expression_values": {":status": "In Progress"}}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -40,7 +40,7 @@ $ slack datastore query '{"datastore": "tasks", "expression": "#status = :status --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -54,7 +54,7 @@ $ slack datastore query '{"datastore": "tasks", "expression": "#status = :status -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_datastore_update.md b/docs/reference/commands/slack_datastore_update.md index 837bb491..e725beb9 100644 --- a/docs/reference/commands/slack_datastore_update.md +++ b/docs/reference/commands/slack_datastore_update.md @@ -1,8 +1,8 @@ -## slack datastore update +# `slack datastore update` Create or update an item in a datastore -### Synopsis +## Synopsis Create or update an item in a datastore. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack datastore update [flags] ``` -### Examples +## Examples ``` # Update the entry in the datastore @@ -23,7 +23,7 @@ $ slack datastore update --datastore tasks '{"item": {"id": "42", "description": $ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "description": "Create a PR", "status": "Done"}}' ``` -### Options +## Options ``` --datastore string the datastore used to store items @@ -32,7 +32,7 @@ $ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "descripti --unstable kick the tires of experimental features ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -46,7 +46,7 @@ $ slack datastore update '{"datastore": "tasks", "item": {"id": "42", "descripti -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack datastore](slack_datastore) - Interact with an app's datastore diff --git a/docs/reference/commands/slack_delete.md b/docs/reference/commands/slack_delete.md index 6aef357f..675f67fb 100644 --- a/docs/reference/commands/slack_delete.md +++ b/docs/reference/commands/slack_delete.md @@ -1,8 +1,8 @@ -## slack delete +# `slack delete` Delete the app -### Synopsis +## Synopsis Uninstall the app from the team and permanently delete the app and all of its data @@ -10,7 +10,7 @@ Uninstall the app from the team and permanently delete the app and all of its da slack delete [flags] ``` -### Examples +## Examples ``` # Delete an app and app info from a team @@ -20,13 +20,13 @@ $ slack app delete $ slack app delete --team T0123456 --app local ``` -### Options +## Options ``` -h, --help help for delete ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -40,7 +40,7 @@ $ slack app delete --team T0123456 --app local -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_deploy.md b/docs/reference/commands/slack_deploy.md index 5a994cae..e705c84d 100644 --- a/docs/reference/commands/slack_deploy.md +++ b/docs/reference/commands/slack_deploy.md @@ -1,8 +1,8 @@ -## slack deploy +# `slack deploy` Deploy the app to the Slack Platform -### Synopsis +## Synopsis Deploy the app to the Slack Platform @@ -10,7 +10,7 @@ Deploy the app to the Slack Platform slack deploy [flags] ``` -### Examples +## Examples ``` # Select the workspace to deploy to @@ -18,7 +18,7 @@ $ slack platform deploy $ slack platform deploy --team T0123456 # Deploy to a specific team ``` -### Options +## Options ``` -h, --help help for deploy @@ -27,7 +27,7 @@ $ slack platform deploy --team T0123456 # Deploy to a specific team (or 'all' for all workspaces in the org) ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -41,7 +41,7 @@ $ slack platform deploy --team T0123456 # Deploy to a specific team -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_doctor.md b/docs/reference/commands/slack_doctor.md index 2c58b715..c1fa0672 100644 --- a/docs/reference/commands/slack_doctor.md +++ b/docs/reference/commands/slack_doctor.md @@ -1,8 +1,8 @@ -## slack doctor +# `slack doctor` Check and report on system and app information -### Synopsis +## Synopsis Check and report on relevant system (and sometimes app) dependencies @@ -19,19 +19,19 @@ Unfortunately, the doctor command cannot heal all problems slack doctor [flags] ``` -### Examples +## Examples ``` $ slack doctor # Create a status report of system dependencies ``` -### Options +## Options ``` -h, --help help for doctor ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -45,7 +45,7 @@ $ slack doctor # Create a status report of system dependencies -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_env.md b/docs/reference/commands/slack_env.md index 0b388b6d..af9a1773 100644 --- a/docs/reference/commands/slack_env.md +++ b/docs/reference/commands/slack_env.md @@ -1,8 +1,8 @@ -## slack env +# `slack env` Add, remove, or list environment variables -### Synopsis +## Synopsis Add, remove, or list environment variables for apps deployed to Slack managed infrastructure. @@ -10,13 +10,13 @@ infrastructure. This command is supported for apps deployed to Slack managed infrastructure but other apps can attempt to run the command with the --force flag. -Explore more: [Environment variables](/slack-cli/guides/using-environment-variables-with-the-slack-cli) +Explore more: [https://tools.slack.dev/slack-cli/guides/using-environment-variables-with-the-slack-cli](https://tools.slack.dev/slack-cli/guides/using-environment-variables-with-the-slack-cli) ``` slack env [flags] ``` -### Examples +## Examples ``` $ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable @@ -28,13 +28,13 @@ $ slack env list $ slack env remove MAGIC_PASSWORD ``` -### Options +## Options ``` -h, --help help for env ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -48,7 +48,7 @@ $ slack env remove MAGIC_PASSWORD -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack env add](slack_env_add) - Add an environment variable to the app diff --git a/docs/reference/commands/slack_env_add.md b/docs/reference/commands/slack_env_add.md index ac7e7c32..207b7a05 100644 --- a/docs/reference/commands/slack_env_add.md +++ b/docs/reference/commands/slack_env_add.md @@ -1,8 +1,8 @@ -## slack env add +# `slack env add` Add an environment variable to the app -### Synopsis +## Synopsis Add an environment variable to an app deployed to Slack managed infrastructure. @@ -15,7 +15,7 @@ other apps can attempt to run the command with the --force flag. slack env add [flags] ``` -### Examples +## Examples ``` # Prompt for an environment variable @@ -26,14 +26,14 @@ $ slack env add MAGIC_PASSWORD abracadbra # Add an environment variable $ slack env add SECRET_PASSWORD ``` -### Options +## Options ``` -h, --help help for add --value string set the environment variable value ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,7 +47,7 @@ $ slack env add SECRET_PASSWORD -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_env_list.md b/docs/reference/commands/slack_env_list.md index 38b2d881..eb26caf2 100644 --- a/docs/reference/commands/slack_env_list.md +++ b/docs/reference/commands/slack_env_list.md @@ -1,8 +1,8 @@ -## slack env list +# `slack env list` List all environment variables for the app -### Synopsis +## Synopsis List all of the environment variables of an app deployed to Slack managed infrastructure. @@ -14,19 +14,19 @@ other apps can attempt to run the command with the --force flag. slack env list [flags] ``` -### Examples +## Examples ``` $ slack env list # List all environment variables ``` -### Options +## Options ``` -h, --help help for list ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -40,7 +40,7 @@ $ slack env list # List all environment variables -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_env_remove.md b/docs/reference/commands/slack_env_remove.md index 8229108f..b81f4e30 100644 --- a/docs/reference/commands/slack_env_remove.md +++ b/docs/reference/commands/slack_env_remove.md @@ -1,8 +1,8 @@ -## slack env remove +# `slack env remove` Remove an environment variable from the app -### Synopsis +## Synopsis Remove an environment variable from an app deployed to Slack managed infrastructure. @@ -16,7 +16,7 @@ other apps can attempt to run the command with the --force flag. slack env remove [flags] ``` -### Examples +## Examples ``` # Select an environment variable to remove @@ -24,14 +24,14 @@ $ slack env remove $ slack env remove MAGIC_PASSWORD # Remove an environment variable ``` -### Options +## Options ``` -h, --help help for remove --name string choose the environment variable name ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -45,7 +45,7 @@ $ slack env remove MAGIC_PASSWORD # Remove an environment variable -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack env](slack_env) - Add, remove, or list environment variables diff --git a/docs/reference/commands/slack_external-auth.md b/docs/reference/commands/slack_external-auth.md index b6e42167..c708fdcc 100644 --- a/docs/reference/commands/slack_external-auth.md +++ b/docs/reference/commands/slack_external-auth.md @@ -1,21 +1,21 @@ -## slack external-auth +# `slack external-auth` Adjust settings of external authentication providers -### Synopsis +## Synopsis Adjust external authorization and authentication providers of a workflow app. This command is supported for apps deployed to Slack managed infrastructure but other apps can attempt to run the command with the --force flag. -Explore providers: [Integrating with external auth providers](/guides/integrating-with-services-requiring-external-authentication/) +Explore providers: [https://tools.slack.dev/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication](https://tools.slack.dev/deno-slack-sdk/guides/integrating-with-services-requiring-external-authentication) ``` slack external-auth [flags] ``` -### Examples +## Examples ``` # Initiate OAuth2 flow for a selected provider @@ -31,13 +31,13 @@ $ slack external-auth remove $ slack external-auth select-auth ``` -### Options +## Options ``` -h, --help help for external-auth ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -51,7 +51,7 @@ $ slack external-auth select-auth -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack external-auth add](slack_external-auth_add) - Initiate the OAuth2 flow for a provider diff --git a/docs/reference/commands/slack_external-auth_add-secret.md b/docs/reference/commands/slack_external-auth_add-secret.md index 51043185..14901281 100644 --- a/docs/reference/commands/slack_external-auth_add-secret.md +++ b/docs/reference/commands/slack_external-auth_add-secret.md @@ -1,8 +1,8 @@ -## slack external-auth add-secret +# `slack external-auth add-secret` Add the client secret for a provider -### Synopsis +## Synopsis Add the client secret for an external provider of a workflow app. @@ -15,7 +15,7 @@ other apps can attempt to run the command with the --force flag. slack external-auth add-secret [flags] ``` -### Examples +## Examples ``` # Input the client secret for an app and provider @@ -25,7 +25,7 @@ $ slack external-auth add-secret $ slack external-auth add-secret -p github -x ghp_token ``` -### Options +## Options ``` -h, --help help for add-secret @@ -33,7 +33,7 @@ $ slack external-auth add-secret -p github -x ghp_token -x, --secret string external auth client secret for the provider ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -47,7 +47,7 @@ $ slack external-auth add-secret -p github -x ghp_token -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_add.md b/docs/reference/commands/slack_external-auth_add.md index 7db24a85..5f784bdf 100644 --- a/docs/reference/commands/slack_external-auth_add.md +++ b/docs/reference/commands/slack_external-auth_add.md @@ -1,8 +1,8 @@ -## slack external-auth add +# `slack external-auth add` Initiate the OAuth2 flow for a provider -### Synopsis +## Synopsis Initiate the OAuth2 flow for an external auth provider of a workflow app. @@ -13,7 +13,7 @@ other apps can attempt to run the command with the --force flag. slack external-auth add [flags] ``` -### Examples +## Examples ``` # Select a provider to initiate the OAuth2 flow for @@ -23,14 +23,14 @@ $ slack external-auth add $ slack external-auth add -p github ``` -### Options +## Options ``` -h, --help help for add -p, --provider string the external auth Provider Key to add a secret to ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -44,7 +44,7 @@ $ slack external-auth add -p github -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_remove.md b/docs/reference/commands/slack_external-auth_remove.md index 042334b5..32f688a1 100644 --- a/docs/reference/commands/slack_external-auth_remove.md +++ b/docs/reference/commands/slack_external-auth_remove.md @@ -1,8 +1,8 @@ -## slack external-auth remove +# `slack external-auth remove` Remove the saved tokens for a provider -### Synopsis +## Synopsis Remove tokens saved to external authentication providers of a workflow app. @@ -16,7 +16,7 @@ other apps can attempt to run the command with the --force flag. slack external-auth remove [flags] ``` -### Examples +## Examples ``` # Remove a token from the selected provider @@ -32,7 +32,7 @@ $ slack external-auth remove --all -p github $ slack external-auth remove --all ``` -### Options +## Options ``` -A, --all remove tokens for all providers or the specified provider @@ -40,7 +40,7 @@ $ slack external-auth remove --all -p, --provider string the external auth Provider Key to remove a token for ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -54,7 +54,7 @@ $ slack external-auth remove --all -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_external-auth_select-auth.md b/docs/reference/commands/slack_external-auth_select-auth.md index f74aec61..daaf56ff 100644 --- a/docs/reference/commands/slack_external-auth_select-auth.md +++ b/docs/reference/commands/slack_external-auth_select-auth.md @@ -1,8 +1,8 @@ -## slack external-auth select-auth +# `slack external-auth select-auth` Select developer authentication of a workflow -### Synopsis +## Synopsis Select the saved developer authentication to use when calling external APIs from functions in a workflow app. @@ -14,14 +14,14 @@ other apps can attempt to run the command with the --force flag. slack external-auth select-auth [flags] ``` -### Examples +## Examples ``` # Select the saved developer authentication in a workflow $ slack external-auth select-auth --workflow #/workflows/workflow_callback --provider google_provider --external-account user@salesforce.com ``` -### Options +## Options ``` -E, --external-account string external account identifier for the provider @@ -30,7 +30,7 @@ $ slack external-auth select-auth --workflow #/workflows/workflow_callback --pro -W, --workflow string workflow to set developer authentication for ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -44,7 +44,7 @@ $ slack external-auth select-auth --workflow #/workflows/workflow_callback --pro -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack external-auth](slack_external-auth) - Adjust settings of external authentication providers diff --git a/docs/reference/commands/slack_feedback.md b/docs/reference/commands/slack_feedback.md index 663d111e..3ffd6730 100644 --- a/docs/reference/commands/slack_feedback.md +++ b/docs/reference/commands/slack_feedback.md @@ -1,8 +1,8 @@ -## slack feedback +# `slack feedback` Share feedback about your experience or project -### Synopsis +## Synopsis Help us make the Slack Platform better with your feedback @@ -10,13 +10,15 @@ Help us make the Slack Platform better with your feedback slack feedback [flags] ``` -### Examples +## Examples ``` +# Choose to give feedback on part of the Slack Platform $ slack feedback +$ slack feedback --name slack-cli # Give feedback on the Slack CLI ``` -### Options +## Options ``` -h, --help help for feedback @@ -27,7 +29,7 @@ $ slack feedback --no-prompt run command without prompts ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -41,7 +43,7 @@ $ slack feedback -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_function.md b/docs/reference/commands/slack_function.md index 598098ea..c17c3694 100644 --- a/docs/reference/commands/slack_function.md +++ b/docs/reference/commands/slack_function.md @@ -1,8 +1,8 @@ -## slack function +# `slack function` Manage the functions of an app -### Synopsis +## Synopsis Functions are pieces of logic that complete the puzzle of workflows in Workflow Builder. Whatever that puzzle might be. @@ -16,7 +16,7 @@ Learn more about functions: [https://tools.slack.dev/deno-slack-sdk/guides/creat slack function [flags] ``` -### Examples +## Examples ``` # Select a function and choose distribution options @@ -29,13 +29,13 @@ $ slack function distribute --name callback_id --everyone $ slack function distribute --info ``` -### Options +## Options ``` -h, --help help for function ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -49,7 +49,7 @@ $ slack function distribute --info -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack function access](slack_function_access) - Adjust who can access functions published from an app diff --git a/docs/reference/commands/slack_function_access.md b/docs/reference/commands/slack_function_access.md index a7feea42..cf307b95 100644 --- a/docs/reference/commands/slack_function_access.md +++ b/docs/reference/commands/slack_function_access.md @@ -1,8 +1,8 @@ -## slack function access +# `slack function access` Adjust who can access functions published from an app -### Synopsis +## Synopsis Adjust who can **access** functions published by an app when building a workflow in Workflow Builder. @@ -19,7 +19,7 @@ only. slack function access [flags] ``` -### Examples +## Examples ``` # Select a function and choose access options @@ -36,7 +36,7 @@ $ slack function access --name callback_id --revoke \ $ slack function access --info ``` -### Options +## Options ``` -A, --app-collaborators grant access to only fellow app collaborators @@ -50,7 +50,7 @@ $ slack function access --info -U, --users string a comma-separated list of Slack user IDs ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -64,7 +64,7 @@ $ slack function access --info -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack function](slack_function) - Manage the functions of an app diff --git a/docs/reference/commands/slack_init.md b/docs/reference/commands/slack_init.md index a5c1d11d..4e60977f 100644 --- a/docs/reference/commands/slack_init.md +++ b/docs/reference/commands/slack_init.md @@ -1,8 +1,8 @@ -## slack init +# `slack init` Initialize a project to work with the Slack CLI -### Synopsis +## Synopsis Initializes a project to support the Slack CLI. @@ -30,19 +30,19 @@ Adds an existing app to your project (optional): slack init [flags] ``` -### Examples +## Examples ``` $ slack init # Initialize a project ``` -### Options +## Options ``` -h, --help help for init ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -56,7 +56,7 @@ $ slack init # Initialize a project -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_install.md b/docs/reference/commands/slack_install.md index ce5186d8..8bbe330b 100644 --- a/docs/reference/commands/slack_install.md +++ b/docs/reference/commands/slack_install.md @@ -1,8 +1,8 @@ -## slack install +# `slack install` Install the app to a team -### Synopsis +## Synopsis Install the app to a team @@ -10,7 +10,7 @@ Install the app to a team slack install [flags] ``` -### Examples +## Examples ``` $ slack app install # Install a production app to a team @@ -19,7 +19,7 @@ $ slack app install # Install a production app to a team $ slack app install --team T0123456 ``` -### Options +## Options ``` -h, --help help for install @@ -27,7 +27,7 @@ $ slack app install --team T0123456 (or 'all' for all workspaces in the org) ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -41,7 +41,7 @@ $ slack app install --team T0123456 -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_list.md b/docs/reference/commands/slack_list.md index 7c08ee75..c949ea10 100644 --- a/docs/reference/commands/slack_list.md +++ b/docs/reference/commands/slack_list.md @@ -1,8 +1,8 @@ -## slack list +# `slack list` List all authorized accounts -### Synopsis +## Synopsis List all authorized accounts @@ -10,19 +10,19 @@ List all authorized accounts slack list [flags] ``` -### Examples +## Examples ``` $ slack auth list # List all authorized accounts ``` -### Options +## Options ``` -h, --help help for list ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,7 +36,7 @@ $ slack auth list # List all authorized accounts -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_login.md b/docs/reference/commands/slack_login.md index baf06d06..f03b81b1 100644 --- a/docs/reference/commands/slack_login.md +++ b/docs/reference/commands/slack_login.md @@ -1,8 +1,8 @@ -## slack login +# `slack login` Log in to a Slack account -### Synopsis +## Synopsis Log in to a Slack account in your team @@ -10,7 +10,7 @@ Log in to a Slack account in your team slack login [flags] ``` -### Examples +## Examples ``` # Login to a Slack account with prompts @@ -26,7 +26,7 @@ $ slack auth login --challenge 6d0a31c9 --ticket ISQWLiZT0OtMLO3YWNTJO0... $ slack auth login --token xoxp-... ``` -### Options +## Options ``` --challenge string provide a challenge code for pre-authenticated login @@ -36,7 +36,7 @@ $ slack auth login --token xoxp-... --token string provide a token for a pre-authenticated login ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -49,7 +49,7 @@ $ slack auth login --token xoxp-... -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_logout.md b/docs/reference/commands/slack_logout.md index 734333eb..ceaae8da 100644 --- a/docs/reference/commands/slack_logout.md +++ b/docs/reference/commands/slack_logout.md @@ -1,8 +1,8 @@ -## slack logout +# `slack logout` Log out of a team -### Synopsis +## Synopsis Log out of a team, removing any local credentials @@ -10,21 +10,21 @@ Log out of a team, removing any local credentials slack logout [flags] ``` -### Examples +## Examples ``` $ slack auth logout # Select a team to log out of $ slack auth logout --all # Log out of all team ``` -### Options +## Options ``` -A, --all logout of all workspaces -h, --help help for logout ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack auth logout --all # Log out of all team -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_manifest.md b/docs/reference/commands/slack_manifest.md index 6035d014..fb40bb45 100644 --- a/docs/reference/commands/slack_manifest.md +++ b/docs/reference/commands/slack_manifest.md @@ -1,8 +1,8 @@ -## slack manifest +# `slack manifest` Print the app manifest of a project or app -### Synopsis +## Synopsis Get the manifest of an app using either the "remote" values on app settings or from the "local" configurations. @@ -17,7 +17,7 @@ Project configurations use the "get-manifest" hook from ".slack/hooks.json". slack manifest [flags] ``` -### Examples +## Examples ``` # Display the app manifest for the current project @@ -27,14 +27,14 @@ $ slack manifest info $ slack manifest validate ``` -### Options +## Options ``` -h, --help help for manifest - --source string source of the app manifest ("local" or "remote") (default "local") + --source string source of the app manifest ("local" or "remote") ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -48,7 +48,7 @@ $ slack manifest validate -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack manifest info](slack_manifest_info) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_manifest_info.md b/docs/reference/commands/slack_manifest_info.md index 8309ec97..96b9c8f9 100644 --- a/docs/reference/commands/slack_manifest_info.md +++ b/docs/reference/commands/slack_manifest_info.md @@ -1,8 +1,8 @@ -## slack manifest info +# `slack manifest info` Print the app manifest of a project or app -### Synopsis +## Synopsis Get the manifest of an app using either the "remote" values on app settings or from the "local" configurations. @@ -15,7 +15,7 @@ Project configurations use the "get-manifest" hook from ".slack/hooks.json". slack manifest info [flags] ``` -### Examples +## Examples ``` # Print the app manifest from project configurations @@ -28,14 +28,14 @@ $ slack manifest info --app A0123456789 $ slack manifest info --source remote ``` -### Options +## Options ``` -h, --help help for info - --source string source of the app manifest ("local" or "remote") (default "local") + --source string source of the app manifest ("local" or "remote") ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -49,7 +49,7 @@ $ slack manifest info --source remote -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack manifest](slack_manifest) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_manifest_validate.md b/docs/reference/commands/slack_manifest_validate.md index 926c95a0..794ed4b7 100644 --- a/docs/reference/commands/slack_manifest_validate.md +++ b/docs/reference/commands/slack_manifest_validate.md @@ -1,8 +1,8 @@ -## slack manifest validate +# `slack manifest validate` Validate the app manifest generated by a project -### Synopsis +## Synopsis Validate the app manifest generated from a valid project directory @@ -10,20 +10,20 @@ Validate the app manifest generated from a valid project directory slack manifest validate [flags] ``` -### Examples +## Examples ``` # Validate the app manifest generated by a project $ slack manifest validate ``` -### Options +## Options ``` -h, --help help for validate ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -37,7 +37,7 @@ $ slack manifest validate -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack manifest](slack_manifest) - Print the app manifest of a project or app diff --git a/docs/reference/commands/slack_platform.md b/docs/reference/commands/slack_platform.md index 34b88f8a..cc035534 100644 --- a/docs/reference/commands/slack_platform.md +++ b/docs/reference/commands/slack_platform.md @@ -1,8 +1,8 @@ -## slack platform +# `slack platform` Deploy and run apps on the Slack Platform -### Synopsis +## Synopsis Deploy and run apps on the Slack Platform @@ -10,7 +10,7 @@ Deploy and run apps on the Slack Platform slack platform [flags] ``` -### Examples +## Examples ``` $ slack run # Run an app locally in a workspace @@ -18,13 +18,13 @@ $ slack deploy --team T0123456 # Deploy to a specific team $ slack activity -t # Continuously poll for new activity logs ``` -### Options +## Options ``` -h, --help help for platform ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack activity -t # Continuously poll for new activity logs -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack platform activity](slack_platform_activity) - Display the app activity logs from the Slack Platform diff --git a/docs/reference/commands/slack_platform_activity.md b/docs/reference/commands/slack_platform_activity.md index 294a39e4..68e29cfe 100644 --- a/docs/reference/commands/slack_platform_activity.md +++ b/docs/reference/commands/slack_platform_activity.md @@ -1,8 +1,8 @@ -## slack platform activity +# `slack platform activity` Display the app activity logs from the Slack Platform -### Synopsis +## Synopsis Display the app activity logs from the Slack Platform @@ -10,14 +10,14 @@ Display the app activity logs from the Slack Platform slack platform activity [flags] ``` -### Examples +## Examples ``` $ slack platform activity # Display app activity logs for an app $ slack platform activity -t # Continuously poll for new activity logs ``` -### Options +## Options ``` --component string component type to filter @@ -40,7 +40,7 @@ $ slack platform activity -t # Continuously poll for new activity logs --trace-id string trace id to filter ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -54,7 +54,7 @@ $ slack platform activity -t # Continuously poll for new activity logs -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_platform_deploy.md b/docs/reference/commands/slack_platform_deploy.md index 979b152a..48040110 100644 --- a/docs/reference/commands/slack_platform_deploy.md +++ b/docs/reference/commands/slack_platform_deploy.md @@ -1,8 +1,8 @@ -## slack platform deploy +# `slack platform deploy` Deploy the app to the Slack Platform -### Synopsis +## Synopsis Deploy the app to the Slack Platform @@ -10,7 +10,7 @@ Deploy the app to the Slack Platform slack platform deploy [flags] ``` -### Examples +## Examples ``` # Select the workspace to deploy to @@ -18,7 +18,7 @@ $ slack platform deploy $ slack platform deploy --team T0123456 # Deploy to a specific team ``` -### Options +## Options ``` -h, --help help for deploy @@ -27,7 +27,7 @@ $ slack platform deploy --team T0123456 # Deploy to a specific team (or 'all' for all workspaces in the org) ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -41,7 +41,7 @@ $ slack platform deploy --team T0123456 # Deploy to a specific team -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_platform_run.md b/docs/reference/commands/slack_platform_run.md index 36347d47..62314829 100644 --- a/docs/reference/commands/slack_platform_run.md +++ b/docs/reference/commands/slack_platform_run.md @@ -1,8 +1,8 @@ -## slack platform run +# `slack platform run` Start a local server to develop and run the app locally -### Synopsis +## Synopsis Start a local server to develop and run the app locally while watching for file changes @@ -10,7 +10,7 @@ Start a local server to develop and run the app locally while watching for file slack platform run [flags] ``` -### Examples +## Examples ``` # Start a local development server @@ -23,7 +23,7 @@ $ slack platform run --activity-level debug $ slack platform run --cleanup ``` -### Options +## Options ``` --activity-level string activity level to display (default "info") @@ -35,7 +35,7 @@ $ slack platform run --cleanup (or 'all' for all workspaces in the org) ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -49,7 +49,7 @@ $ slack platform run --cleanup -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack platform](slack_platform) - Deploy and run apps on the Slack Platform diff --git a/docs/reference/commands/slack_project.md b/docs/reference/commands/slack_project.md index 457149f8..635b81e1 100644 --- a/docs/reference/commands/slack_project.md +++ b/docs/reference/commands/slack_project.md @@ -1,8 +1,8 @@ -## slack project +# `slack project` Create, manage, and doctor a project -### Synopsis +## Synopsis Create, manage, and doctor a project and its configuration files. @@ -16,7 +16,7 @@ Check your project health and diagnose problems with the **doctor** command. slack project [flags] ``` -### Examples +## Examples ``` # Creates a new Slack project from an optional template @@ -29,13 +29,13 @@ $ slack project init $ slack project samples ``` -### Options +## Options ``` -h, --help help for project ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -49,7 +49,7 @@ $ slack project samples -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack project create](slack_project_create) - Create a new Slack project diff --git a/docs/reference/commands/slack_project_create.md b/docs/reference/commands/slack_project_create.md index 52c43f46..c9e0c2f1 100644 --- a/docs/reference/commands/slack_project_create.md +++ b/docs/reference/commands/slack_project_create.md @@ -1,8 +1,8 @@ -## slack project create +# `slack project create` Create a new Slack project -### Synopsis +## Synopsis Create a new Slack project on your local machine from an optional template @@ -10,7 +10,7 @@ Create a new Slack project on your local machine from an optional template slack project create [name] [flags] ``` -### Examples +## Examples ``` # Create a new project from a template @@ -20,7 +20,7 @@ $ slack create my-project $ slack create my-project -t slack-samples/deno-hello-world ``` -### Options +## Options ``` -b, --branch string name of git branch to checkout @@ -28,7 +28,7 @@ $ slack create my-project -t slack-samples/deno-hello-world -t, --template string template URL for your app ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -42,7 +42,7 @@ $ slack create my-project -t slack-samples/deno-hello-world -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_project_init.md b/docs/reference/commands/slack_project_init.md index 1e9902d5..d7fa12a8 100644 --- a/docs/reference/commands/slack_project_init.md +++ b/docs/reference/commands/slack_project_init.md @@ -1,8 +1,8 @@ -## slack project init +# `slack project init` Initialize a project to work with the Slack CLI -### Synopsis +## Synopsis Initializes a project to support the Slack CLI. @@ -30,19 +30,19 @@ Adds an existing app to your project (optional): slack project init [flags] ``` -### Examples +## Examples ``` $ slack init # Initialize a project ``` -### Options +## Options ``` -h, --help help for init ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -56,7 +56,7 @@ $ slack init # Initialize a project -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_project_samples.md b/docs/reference/commands/slack_project_samples.md index 538c35f1..3dfe9510 100644 --- a/docs/reference/commands/slack_project_samples.md +++ b/docs/reference/commands/slack_project_samples.md @@ -1,8 +1,8 @@ -## slack project samples +# `slack project samples` List available sample apps -### Synopsis +## Synopsis List and create an app from the available samples @@ -10,13 +10,13 @@ List and create an app from the available samples slack project samples [flags] ``` -### Examples +## Examples ``` $ slack samples # Select a sample app to create ``` -### Options +## Options ``` -b, --branch string name of git branch to checkout @@ -24,7 +24,7 @@ $ slack samples # Select a sample app to create -t, --template string template URL for your app ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack samples # Select a sample app to create -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack project](slack_project) - Create, manage, and doctor a project diff --git a/docs/reference/commands/slack_run.md b/docs/reference/commands/slack_run.md index eb9c10f8..6d3d436d 100644 --- a/docs/reference/commands/slack_run.md +++ b/docs/reference/commands/slack_run.md @@ -1,8 +1,8 @@ -## slack run +# `slack run` Start a local server to develop and run the app locally -### Synopsis +## Synopsis Start a local server to develop and run the app locally while watching for file changes @@ -10,7 +10,7 @@ Start a local server to develop and run the app locally while watching for file slack run [flags] ``` -### Examples +## Examples ``` # Start a local development server @@ -23,7 +23,7 @@ $ slack platform run --activity-level debug $ slack platform run --cleanup ``` -### Options +## Options ``` --activity-level string activity level to display (default "info") @@ -35,7 +35,7 @@ $ slack platform run --cleanup (or 'all' for all workspaces in the org) ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -49,7 +49,7 @@ $ slack platform run --cleanup -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_samples.md b/docs/reference/commands/slack_samples.md index 6956a60c..c4f4ac4f 100644 --- a/docs/reference/commands/slack_samples.md +++ b/docs/reference/commands/slack_samples.md @@ -1,8 +1,8 @@ -## slack samples +# `slack samples` List available sample apps -### Synopsis +## Synopsis List and create an app from the available samples @@ -10,13 +10,13 @@ List and create an app from the available samples slack samples [flags] ``` -### Examples +## Examples ``` $ slack samples # Select a sample app to create ``` -### Options +## Options ``` -b, --branch string name of git branch to checkout @@ -24,7 +24,7 @@ $ slack samples # Select a sample app to create -t, --template string template URL for your app ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -38,7 +38,7 @@ $ slack samples # Select a sample app to create -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_trigger.md b/docs/reference/commands/slack_trigger.md index d8c37b35..f62c6687 100644 --- a/docs/reference/commands/slack_trigger.md +++ b/docs/reference/commands/slack_trigger.md @@ -1,8 +1,8 @@ -## slack trigger +# `slack trigger` List details of existing triggers -### Synopsis +## Synopsis List details of existing triggers @@ -10,7 +10,7 @@ List details of existing triggers slack trigger [flags] ``` -### Examples +## Examples ``` # Select who can run a trigger @@ -30,13 +30,13 @@ $ slack trigger list $ slack trigger update --trigger-id Ft01234ABCD ``` -### Options +## Options ``` -h, --help help for trigger ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -50,7 +50,7 @@ $ slack trigger update --trigger-id Ft01234ABCD -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool * [slack trigger access](slack_trigger_access) - Manage who can use your triggers diff --git a/docs/reference/commands/slack_trigger_access.md b/docs/reference/commands/slack_trigger_access.md index 2c5e52d6..11d23bb9 100644 --- a/docs/reference/commands/slack_trigger_access.md +++ b/docs/reference/commands/slack_trigger_access.md @@ -1,8 +1,8 @@ -## slack trigger access +# `slack trigger access` Manage who can use your triggers -### Synopsis +## Synopsis Manage who can use your triggers @@ -10,7 +10,7 @@ Manage who can use your triggers slack trigger access --trigger-id [flags] ``` -### Examples +## Examples ``` # Grant everyone access to run a trigger @@ -25,7 +25,7 @@ $ slack trigger access --trigger-id Ft01234ABCD --revoke \ --users USLACKBOT,U012345678 ``` -### Options +## Options ``` -A, --app-collaborators grant permission to only app collaborators @@ -45,7 +45,7 @@ $ slack trigger access --trigger-id Ft01234ABCD --revoke \ -W, --workspaces string a comma-separated list of Slack workspace IDs ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -59,7 +59,7 @@ $ slack trigger access --trigger-id Ft01234ABCD --revoke \ -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_create.md b/docs/reference/commands/slack_trigger_create.md index c0d824c5..a0457d9d 100644 --- a/docs/reference/commands/slack_trigger_create.md +++ b/docs/reference/commands/slack_trigger_create.md @@ -1,8 +1,8 @@ -## slack trigger create +# `slack trigger create` Create a trigger for a workflow -### Synopsis +## Synopsis Create a trigger to start a workflow @@ -10,7 +10,7 @@ Create a trigger to start a workflow slack trigger create [flags] ``` -### Examples +## Examples ``` # Create a trigger by selecting an app and trigger definition @@ -23,7 +23,7 @@ $ slack trigger create --trigger-def "triggers/shortcut_trigger.ts" $ slack trigger create --workflow "#/workflows/my_workflow" ``` -### Options +## Options ``` --description string the description of this trigger @@ -47,7 +47,7 @@ $ slack trigger create --workflow "#/workflows/my_workflow" "#/workflows/" ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -61,7 +61,7 @@ $ slack trigger create --workflow "#/workflows/my_workflow" -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_delete.md b/docs/reference/commands/slack_trigger_delete.md index 2bcd3c73..386ebdaf 100644 --- a/docs/reference/commands/slack_trigger_delete.md +++ b/docs/reference/commands/slack_trigger_delete.md @@ -1,8 +1,8 @@ -## slack trigger delete +# `slack trigger delete` Delete an existing trigger -### Synopsis +## Synopsis Delete an existing trigger @@ -10,7 +10,7 @@ Delete an existing trigger slack trigger delete --trigger-id [flags] ``` -### Examples +## Examples ``` # Delete a specific trigger in a selected workspace @@ -20,14 +20,14 @@ $ slack trigger delete --trigger-id Ft01234ABCD $ slack trigger delete --trigger-id Ft01234ABCD --app A0123456 ``` -### Options +## Options ``` -h, --help help for delete --trigger-id string the ID of the trigger ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -41,7 +41,7 @@ $ slack trigger delete --trigger-id Ft01234ABCD --app A0123456 -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_info.md b/docs/reference/commands/slack_trigger_info.md index 21b81ffc..b58b08bd 100644 --- a/docs/reference/commands/slack_trigger_info.md +++ b/docs/reference/commands/slack_trigger_info.md @@ -1,8 +1,8 @@ -## slack trigger info +# `slack trigger info` Get details for a specific trigger -### Synopsis +## Synopsis Get details for a specific trigger @@ -10,7 +10,7 @@ Get details for a specific trigger slack trigger info --trigger-id [flags] ``` -### Examples +## Examples ``` # Get details for a specific trigger in a selected workspace @@ -20,14 +20,14 @@ $ slack trigger info --trigger-id Ft01234ABCD $ slack trigger info --trigger-id Ft01234ABCD --app A0123456 ``` -### Options +## Options ``` -h, --help help for info --trigger-id string the ID of the trigger ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -41,7 +41,7 @@ $ slack trigger info --trigger-id Ft01234ABCD --app A0123456 -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_list.md b/docs/reference/commands/slack_trigger_list.md index b90c8b14..a46a0fe0 100644 --- a/docs/reference/commands/slack_trigger_list.md +++ b/docs/reference/commands/slack_trigger_list.md @@ -1,8 +1,8 @@ -## slack trigger list +# `slack trigger list` List details of existing triggers -### Synopsis +## Synopsis List details of existing triggers @@ -10,7 +10,7 @@ List details of existing triggers slack trigger list [flags] ``` -### Examples +## Examples ``` # List details for all existing triggers @@ -20,7 +20,7 @@ $ slack trigger list $ slack trigger list --team T0123456 --app local ``` -### Options +## Options ``` -h, --help help for list @@ -28,7 +28,7 @@ $ slack trigger list --team T0123456 --app local -T, --type string Only display triggers of the given type, can be one of 'all', 'shortcut', 'event', 'scheduled', 'webhook', and 'external' (default "all") ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -42,7 +42,7 @@ $ slack trigger list --team T0123456 --app local -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_trigger_update.md b/docs/reference/commands/slack_trigger_update.md index 6be60a4b..117b1f14 100644 --- a/docs/reference/commands/slack_trigger_update.md +++ b/docs/reference/commands/slack_trigger_update.md @@ -1,8 +1,8 @@ -## slack trigger update +# `slack trigger update` Updates an existing trigger -### Synopsis +## Synopsis Updates an existing trigger with the provided definition. Only supports full replacement, no partial update. @@ -10,7 +10,7 @@ Updates an existing trigger with the provided definition. Only supports full rep slack trigger update --trigger-id [flags] ``` -### Examples +## Examples ``` # Update a trigger definition with a selected file @@ -21,7 +21,7 @@ $ slack trigger update --trigger-id Ft01234ABCD \ --workflow "#/workflows/my_workflow" --title "Updated trigger" ``` -### Options +## Options ``` --description string the description of this trigger @@ -44,7 +44,7 @@ $ slack trigger update --trigger-id Ft01234ABCD \ "#/workflows/" ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -58,7 +58,7 @@ $ slack trigger update --trigger-id Ft01234ABCD \ -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack trigger](slack_trigger) - List details of existing triggers diff --git a/docs/reference/commands/slack_uninstall.md b/docs/reference/commands/slack_uninstall.md index b91cfcad..c947a4d2 100644 --- a/docs/reference/commands/slack_uninstall.md +++ b/docs/reference/commands/slack_uninstall.md @@ -1,8 +1,8 @@ -## slack uninstall +# `slack uninstall` Uninstall the app from a team -### Synopsis +## Synopsis Uninstall the app from a team without deleting the app or its data @@ -10,19 +10,19 @@ Uninstall the app from a team without deleting the app or its data slack uninstall [flags] ``` -### Examples +## Examples ``` $ slack app uninstall # Uninstall an app from a team ``` -### Options +## Options ``` -h, --help help for uninstall ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -36,7 +36,7 @@ $ slack app uninstall # Uninstall an app from a team -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_upgrade.md b/docs/reference/commands/slack_upgrade.md index 99858cbd..8267c6b7 100644 --- a/docs/reference/commands/slack_upgrade.md +++ b/docs/reference/commands/slack_upgrade.md @@ -1,32 +1,32 @@ -## slack upgrade +# `slack upgrade` Checks for available updates to the CLI or SDK -### Synopsis +## Synopsis Checks for available updates to the CLI or the SDKs of a project If there are any, then you will be prompted to upgrade -The changelog can be found at [https://docs.slack.dev/changelog/](https://docs.slack.dev/changelog/) +The changelog can be found at [https://docs.slack.dev/changelog](https://docs.slack.dev/changelog) ``` slack upgrade [flags] ``` -### Examples +## Examples ``` $ slack upgrade # Check for any available updates ``` -### Options +## Options ``` -h, --help help for upgrade ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -40,7 +40,7 @@ $ slack upgrade # Check for any available updates -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/commands/slack_version.md b/docs/reference/commands/slack_version.md index 1bde289b..2169942e 100644 --- a/docs/reference/commands/slack_version.md +++ b/docs/reference/commands/slack_version.md @@ -1,22 +1,50 @@ -## slack version +# `slack version` Print the version number -### Synopsis +## Synopsis All software has versions. This is ours. +Version numbers follow the semantic versioning specification (semver) +and are always prefixed with a `v`, such as `v3.0.1`. + +Given a version number MAJOR.MINOR.PATCH: + +1. MAJOR versions have incompatible, breaking changes +2. MINOR versions add functionality that is a backward compatible +3. PATCH versions make bug fixes that are backward compatible + +Experiments are patch version until officially released. + +Development builds use `git describe` and contain helpful info, +such as the prior release and specific commit of the build. + +Given a version number `v3.0.1-7-g822d09a`: + +1. `v3.0.1` is the version of the prior release +2. `7` is the number of commits ahead of the `v3.0.1` git tag +3. `g822d09a` is the git commit for this build, prefixed with `g` + ``` slack version [flags] ``` -### Options +## Examples + +``` +$ slack version # Print version number using the command +$ slack --version # Print version number using the flag +$ slack --version --skip-update # Print version and skip update check +``` + +## Options ``` -h, --help help for version ``` -### Options inherited from parent commands +## Options inherited from parent commands ``` -a, --app string use a specific app ID or environment @@ -30,7 +58,7 @@ slack version [flags] -v, --verbose print debug logging and additional info ``` -### SEE ALSO +## SEE ALSO * [slack](slack) - Slack command-line tool diff --git a/docs/reference/errors.md b/docs/reference/errors.md index 0dc696d7..9f6f1286 100644 --- a/docs/reference/errors.md +++ b/docs/reference/errors.md @@ -97,9 +97,11 @@ and some ways to remediate them. **Message**: Deployment to Slack is not currently supported for apps with `runOnSlack` set as false -**Remediation**: Learn about building apps with the Deno Slack SDK: tools.slack.dev/deno-slack-sdk/ -If you are using a Bolt framework, deployment is supported under an experiment. -Add a deploy hook then run: `slack deploy --experiment=bolt` +**Remediation**: Learn about building apps with the Deno Slack SDK: + +https://tools.slack.dev/deno-slack-sdk + +If you are using a Bolt framework, add a deploy hook then run: `slack deploy` Otherwise start your app for local development with: `slack run` @@ -121,7 +123,7 @@ Otherwise start your app for local development with: `slack run` **Message**: The --app flag must be provided -**Remediation**: Choose a specific app with ``--app `` +**Remediation**: Choose a specific app with `--app ` --- @@ -131,6 +133,12 @@ Otherwise start your app for local development with: `slack run` --- +### app_hosted {#app_hosted} + +**Message**: App is configured for Run on Slack infrastructure + +--- + ### app_install_error {#app_install_error} **Message**: Couldn't install your app to a workspace @@ -319,7 +327,8 @@ Learn more: https://slack.com/help/articles/201980108-Add-people-to-a-channel **Message**: Couldn't auto-update this command-line tool -**Remediation**: You can manually install the latest version from http://localhost:3000/slack-cli/guides/installing-the-slack-cli-for-mac-and-linux. +**Remediation**: You can manually install the latest version from: +https://tools.slack.dev/slack-cli --- @@ -407,6 +416,12 @@ Approval is pending review --- +### context_value_not_found {#context_value_not_found} + +**Message**: The context value could not be found + +--- + ### credentials_not_found {#credentials_not_found} **Message**: No authentication found for this team @@ -539,6 +554,23 @@ Approval is pending review --- +### feedback_name_invalid {#feedback_name_invalid} + +**Message**: The name of the feedback is invalid + +**Remediation**: View the feedback options with `slack feedback --help` + +--- + +### feedback_name_required {#feedback_name_required} + +**Message**: The name of the feedback is required + +**Remediation**: Please provide a `--name ` flag or remove the --no-prompt flag +View feedback options with `slack feedback --help` + +--- + ### file_rejected {#file_rejected} **Message**: Not an acceptable S3 file @@ -673,6 +705,8 @@ Approval is pending review **Remediation**: A valid Slack project includes the Slack hooks file: .slack/hooks.json +If this is a Slack project, you can initialize it with `slack init` + --- ### invalid_app_flag {#invalid_app_flag} @@ -680,7 +714,7 @@ Approval is pending review **Message**: The provided --app flag value is not valid **Remediation**: Specify the environment with --app local or --app deployed -Or choose a specific app with ``--app `` +Or choose a specific app with `--app ` --- @@ -1251,12 +1285,16 @@ Read about manifest sourcing with the `slack manifest info --help` command **Message**: A script in .slack/hooks.json was not found -**Remediation**: Hook scripts are defined in the Slack hooks file ('.slack/hooks.json'). -Every app requires a Slack hooks file and you can find a working example at: +**Remediation**: Hook scripts are defined in one of these Slack hooks files: +- slack.json +- .slack/hooks.json + +Every app requires a Slack hooks file and you can find an example at: +https://github.com/slack-samples/deno-starter-template/blob/main/slack.json -https://github.com/slack-samples/deno-starter-template/blob/main/.slack/hooks.json +You can create a hooks file manually or with the `slack init` command. -After creating the hooks file, you must install related hook dependencies. +When manually creating the hooks file, you must install the hook dependencies. --- @@ -1338,7 +1376,7 @@ Move the .slack/slack.json file to .slack/hooks.json and proceed again. **Message**: The --team flag must be provided -**Remediation**: Choose a specific team with ``--team `` or ``--team `` +**Remediation**: Choose a specific team with `--team ` or `--team ` ---