Skip to content

Commit 2609783

Browse files
docs: updates cli reference docs (#198)
* adds files as test * build run * build run * removes workflow
1 parent 859d4f1 commit 2609783

74 files changed

Lines changed: 1051 additions & 1031 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/reference/commands/slack.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,17 @@
22

33
Slack command-line tool
44

5-
## Synopsis
5+
## Description
66

77
CLI to create, run, and deploy Slack apps
88

9-
Get started by reading the docs: [https://docs.slack.dev/tools/slack-cli](https://docs.slack.dev/tools/slack-cli/)
9+
Get started by reading the docs: [https://docs.slack.dev/tools/slack-cli](https://docs.slack.dev/tools/slack-cli)
1010

1111
```
1212
slack <command> <subcommand> [flags]
1313
```
1414

15-
## Examples
16-
17-
```
18-
$ slack login # Log in to your Slack account
19-
$ slack create # Create a new Slack app
20-
$ slack init # Initialize an existing Slack app
21-
$ slack run # Start a local development server
22-
$ slack deploy # Deploy to the Slack Platform
23-
```
24-
25-
## Options
15+
## Flags
2616

2717
```
2818
-a, --app string use a specific app ID or environment
@@ -37,7 +27,17 @@ $ slack deploy # Deploy to the Slack Platform
3727
-v, --verbose print debug logging and additional info
3828
```
3929

40-
## SEE ALSO
30+
## Examples
31+
32+
```
33+
$ slack login # Log in to your Slack account
34+
$ slack create # Create a new Slack app
35+
$ slack init # Initialize an existing Slack app
36+
$ slack run # Start a local development server
37+
$ slack deploy # Deploy to the Slack Platform
38+
```
39+
40+
## See also
4141

4242
* [slack activity](slack_activity) - Display the app activity logs from the Slack Platform
4343
* [slack app](slack_app) - Install, uninstall, and list teams with the app installed

docs/reference/commands/slack_activity.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,15 @@
22

33
Display the app activity logs from the Slack Platform
44

5-
## Synopsis
5+
## Description
66

77
Display the app activity logs from the Slack Platform
88

99
```
1010
slack activity [flags]
1111
```
1212

13-
## Examples
14-
15-
```
16-
$ slack platform activity # Display app activity logs for an app
17-
$ slack platform activity -t # Continuously poll for new activity logs
18-
```
19-
20-
## Options
13+
## Flags
2114

2215
```
2316
--component string component type to filter
@@ -40,7 +33,7 @@ $ slack platform activity -t # Continuously poll for new activity logs
4033
--trace-id string trace id to filter
4134
```
4235

43-
## Options inherited from parent commands
36+
## Global flags
4437

4538
```
4639
-a, --app string use a specific app ID or environment
@@ -54,7 +47,14 @@ $ slack platform activity -t # Continuously poll for new activity logs
5447
-v, --verbose print debug logging and additional info
5548
```
5649

57-
## SEE ALSO
50+
## Examples
51+
52+
```
53+
$ slack platform activity # Display app activity logs for an app
54+
$ slack platform activity -t # Continuously poll for new activity logs
55+
```
56+
57+
## See also
5858

5959
* [slack](slack) - Slack command-line tool
6060

docs/reference/commands/slack_app.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,21 @@
22

33
Install, uninstall, and list teams with the app installed
44

5-
## Synopsis
5+
## Description
66

77
Install, uninstall, and list teams with the app installed
88

99
```
1010
slack app [flags]
1111
```
1212

13-
## Examples
14-
15-
```
16-
$ slack app install # Install a production app to a team
17-
$ slack app link # Link an existing app to the project
18-
$ slack app list # List all teams with the app installed
19-
$ slack app settings # Open app settings in a web browser
20-
$ slack app uninstall # Uninstall an app from a team
21-
$ slack app delete # Delete an app and app info from a team
22-
```
23-
24-
## Options
13+
## Flags
2514

2615
```
2716
-h, --help help for app
2817
```
2918

30-
## Options inherited from parent commands
19+
## Global flags
3120

3221
```
3322
-a, --app string use a specific app ID or environment
@@ -41,7 +30,18 @@ $ slack app delete # Delete an app and app info from a team
4130
-v, --verbose print debug logging and additional info
4231
```
4332

44-
## SEE ALSO
33+
## Examples
34+
35+
```
36+
$ slack app install # Install a production app to a team
37+
$ slack app link # Link an existing app to the project
38+
$ slack app list # List all teams with the app installed
39+
$ slack app settings # Open app settings in a web browser
40+
$ slack app uninstall # Uninstall an app from a team
41+
$ slack app delete # Delete an app and app info from a team
42+
```
43+
44+
## See also
4545

4646
* [slack](slack) - Slack command-line tool
4747
* [slack app delete](slack_app_delete) - Delete the app

docs/reference/commands/slack_app_delete.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,21 @@
22

33
Delete the app
44

5-
## Synopsis
5+
## Description
66

77
Uninstall the app from the team and permanently delete the app and all of its data
88

99
```
1010
slack app delete [flags]
1111
```
1212

13-
## Examples
14-
15-
```
16-
# Delete an app and app info from a team
17-
$ slack app delete
18-
19-
# Delete a specific app from a team
20-
$ slack app delete --team T0123456 --app local
21-
```
22-
23-
## Options
13+
## Flags
2414

2515
```
2616
-h, --help help for delete
2717
```
2818

29-
## Options inherited from parent commands
19+
## Global flags
3020

3121
```
3222
-a, --app string use a specific app ID or environment
@@ -40,7 +30,17 @@ $ slack app delete --team T0123456 --app local
4030
-v, --verbose print debug logging and additional info
4131
```
4232

43-
## SEE ALSO
33+
## Examples
34+
35+
```
36+
# Delete an app and app info from a team
37+
$ slack app delete
38+
39+
# Delete a specific app from a team
40+
$ slack app delete --team T0123456 --app local
41+
```
42+
43+
## See also
4444

4545
* [slack app](slack_app) - Install, uninstall, and list teams with the app installed
4646

docs/reference/commands/slack_app_install.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,24 @@
22

33
Install the app to a team
44

5-
## Synopsis
5+
## Description
66

77
Install the app to a team
88

99
```
1010
slack app install [flags]
1111
```
1212

13-
## Examples
14-
15-
```
16-
$ slack app install # Install a production app to a team
17-
18-
# Install a production app to a specific team
19-
$ slack app install --team T0123456
20-
```
21-
22-
## Options
13+
## Flags
2314

2415
```
16+
-E, --environment string environment of app (local, deployed)
2517
-h, --help help for install
2618
--org-workspace-grant string grant access to a specific org workspace ID
2719
(or 'all' for all workspaces in the org)
2820
```
2921

30-
## Options inherited from parent commands
22+
## Global flags
3123

3224
```
3325
-a, --app string use a specific app ID or environment
@@ -41,7 +33,20 @@ $ slack app install --team T0123456
4133
-v, --verbose print debug logging and additional info
4234
```
4335

44-
## SEE ALSO
36+
## Examples
37+
38+
```
39+
# Install a production app to a team
40+
$ slack app install
41+
42+
# Install a production app to a specific team
43+
$ slack app install --team T0123456 --environment deployed
44+
45+
# Install a local dev app to a specific team
46+
$ slack app install --team T0123456 --environment local
47+
```
48+
49+
## See also
4550

4651
* [slack app](slack_app) - Install, uninstall, and list teams with the app installed
4752

docs/reference/commands/slack_app_link.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Add an existing app to the project
44

5-
## Synopsis
5+
## Description
66

77
Saves an existing app to a project to be available to other commands.
88

@@ -19,24 +19,14 @@ Only one app can exist for each combination of Team ID and environment.
1919
slack app link [flags]
2020
```
2121

22-
## Examples
23-
24-
```
25-
# Add an existing app to a project
26-
$ slack app link
27-
28-
# Add a specific app without using prompts
29-
$ slack app link --team T0123456789 --app A0123456789 --environment deployed
30-
```
31-
32-
## Options
22+
## Flags
3323

3424
```
3525
-E, --environment string environment to save existing app (local, deployed)
3626
-h, --help help for link
3727
```
3828

39-
## Options inherited from parent commands
29+
## Global flags
4030

4131
```
4232
-a, --app string use a specific app ID or environment
@@ -50,7 +40,17 @@ $ slack app link --team T0123456789 --app A0123456789 --environment deployed
5040
-v, --verbose print debug logging and additional info
5141
```
5242

53-
## SEE ALSO
43+
## Examples
44+
45+
```
46+
# Add an existing app to a project
47+
$ slack app link
48+
49+
# Add a specific app without using prompts
50+
$ slack app link --team T0123456789 --app A0123456789 --environment deployed
51+
```
52+
53+
## See also
5454

5555
* [slack app](slack_app) - Install, uninstall, and list teams with the app installed
5656

docs/reference/commands/slack_app_list.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,23 @@
22

33
List teams with the app installed
44

5-
## Synopsis
5+
## Description
66

77
List all teams that have installed the app
88

99
```
1010
slack app list [flags]
1111
```
1212

13-
## Examples
14-
15-
```
16-
$ slack app list # List all teams with the app installed
17-
```
18-
19-
## Options
13+
## Flags
2014

2115
```
2216
--all-org-workspace-grants display all workspace grants for an app
2317
installed to an organization
2418
-h, --help help for list
2519
```
2620

27-
## Options inherited from parent commands
21+
## Global flags
2822

2923
```
3024
-a, --app string use a specific app ID or environment
@@ -38,7 +32,13 @@ $ slack app list # List all teams with the app installed
3832
-v, --verbose print debug logging and additional info
3933
```
4034

41-
## SEE ALSO
35+
## Examples
36+
37+
```
38+
$ slack app list # List all teams with the app installed
39+
```
40+
41+
## See also
4242

4343
* [slack app](slack_app) - Install, uninstall, and list teams with the app installed
4444

0 commit comments

Comments
 (0)