Skip to content

Commit f368799

Browse files
committed
docs: generate
1 parent 5635708 commit f368799

4 files changed

Lines changed: 52 additions & 46 deletions

File tree

docs/english/reference/cli-test/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @slack/cli-test v2.2.2
1+
# @slack/cli-test v3.0.0
22

33
## Classes
44

docs/english/reference/cli-test/variables/SlackCLI.md

Lines changed: 37 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -216,26 +216,6 @@ remove: (args) => Promise<string>;
216216

217217
command output
218218

219-
### create()
220-
221-
```ts
222-
create: (args) => Promise<string>;
223-
```
224-
225-
`slack create`
226-
227-
#### Parameters
228-
229-
##### args
230-
231-
`ProjectCommandArguments` & `object`
232-
233-
#### Returns
234-
235-
`Promise`\<`string`\>
236-
237-
command output
238-
239219
### datastore
240220

241221
```ts
@@ -328,53 +308,53 @@ command output
328308
env: object;
329309
```
330310

331-
#### env.add()
311+
#### env.list()
332312

333313
```ts
334-
add: (args) => Promise<string>;
314+
list: (args) => Promise<string>;
335315
```
336316

337-
`slack env add`
317+
`slack env list`
338318

339319
##### Parameters
340320

341321
###### args
342322

343-
`ProjectCommandArguments` & `EnvCommandArguments`
323+
`ProjectCommandArguments`
344324

345325
##### Returns
346326

347327
`Promise`\<`string`\>
348328

349329
command output
350330

351-
#### env.list()
331+
#### env.set()
352332

353333
```ts
354-
list: (args) => Promise<string>;
334+
set: (args) => Promise<string>;
355335
```
356336

357-
`slack env list`
337+
`slack env set`
358338

359339
##### Parameters
360340

361341
###### args
362342

363-
`ProjectCommandArguments`
343+
`ProjectCommandArguments` & `EnvCommandArguments`
364344

365345
##### Returns
366346

367347
`Promise`\<`string`\>
368348

369349
command output
370350

371-
#### env.remove()
351+
#### env.unset()
372352

373353
```ts
374-
remove: (args) => Promise<string>;
354+
unset: (args) => Promise<string>;
375355
```
376356

377-
`slack env remove`
357+
`slack env unset`
378358

379359
##### Parameters
380360

@@ -672,6 +652,32 @@ stop `slack run`
672652

673653
`Promise`\<`void`\>
674654

655+
### project
656+
657+
```ts
658+
project: object;
659+
```
660+
661+
#### project.create()
662+
663+
```ts
664+
create: (args) => Promise<string>;
665+
```
666+
667+
`slack create`
668+
669+
##### Parameters
670+
671+
###### args
672+
673+
`ProjectCommandArguments` & `object`
674+
675+
##### Returns
676+
677+
`Promise`\<`string`\>
678+
679+
command output
680+
675681
### stopSession()
676682

677683
```ts

docs/english/reference/cli-test/variables/SlackTracerId.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,6 @@ SLACK_TRACE_DATASTORE_COUNT_SUCCESS: string = 'SLACK_TRACE_DATASTORE_COUNT_SUCCE
192192
SLACK_TRACE_DATASTORE_COUNT_TOTAL: string = 'SLACK_TRACE_DATASTORE_COUNT_TOTAL';
193193
```
194194

195-
### SLACK\_TRACE\_ENV\_ADD\_SUCCESS
196-
197-
```ts
198-
SLACK_TRACE_ENV_ADD_SUCCESS: string = 'SLACK_TRACE_ENV_ADD_SUCCESS';
199-
```
200-
201195
### SLACK\_TRACE\_ENV\_LIST\_COUNT
202196

203197
```ts
@@ -210,10 +204,16 @@ SLACK_TRACE_ENV_LIST_COUNT: string = 'SLACK_TRACE_ENV_LIST_COUNT';
210204
SLACK_TRACE_ENV_LIST_VARIABLES: string = 'SLACK_TRACE_ENV_LIST_VARIABLES';
211205
```
212206

213-
### SLACK\_TRACE\_ENV\_REMOVE\_SUCCESS
207+
### SLACK\_TRACE\_ENV\_SET\_SUCCESS
208+
209+
```ts
210+
SLACK_TRACE_ENV_SET_SUCCESS: string = 'SLACK_TRACE_ENV_SET_SUCCESS';
211+
```
212+
213+
### SLACK\_TRACE\_ENV\_UNSET\_SUCCESS
214214

215215
```ts
216-
SLACK_TRACE_ENV_REMOVE_SUCCESS: string = 'SLACK_TRACE_ENV_REMOVE_SUCCESS';
216+
SLACK_TRACE_ENV_UNSET_SUCCESS: string = 'SLACK_TRACE_ENV_UNSET_SUCCESS';
217217
```
218218

219219
### SLACK\_TRACE\_FEEDBACK\_MESSAGE

packages/cli-test/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This library is designed to automate the [Slack Platform Command Line Interface]
66

77
# Requirements
88

9-
1. Ensure the [Slack CLI][cli] (version 2.32.2 or higher) is installed on your system.
9+
1. Ensure the [Slack CLI][cli] (version 4.0.0 or higher) is installed on your system.
1010
2. Export the path to the CLI binary as a `SLACK_CLI_PATH` environment variable.
1111

1212
# Quickstart
@@ -18,8 +18,8 @@ npm install @slack/cli-test
1818
```
1919

2020
2. Set the path to the CLI executable using the environment variable `SLACK_CLI_PATH`
21-
- supply a link to a binary on the global path, like `slack-cli`
22-
- it will default to using `slack` otherwise
21+
- supply a link to a binary on the global path, like `slack-cli`
22+
- it will default to using `slack` otherwise
2323
3. Import and use `SlackCLI` to automate the CLI!
2424

2525
```ts
@@ -33,11 +33,11 @@ const createOutput = await SlackCLI.createAppFromTemplate('slackapi/deno-hello-w
3333
This package exports the following:
3434

3535
1. `SlackCLI` - an object containing a variety of methods to interact with the CLI
36-
- methods are named after [Slack CLI commands][commands], e.g. `SlackCLI.deploy()`
36+
- methods are named after [Slack CLI commands][commands], e.g. `SlackCLI.deploy()`
3737
2. `SlackCLIProcess` - a class that can be instantiated that exposes the ability to run arbitrary commands, with optional global flags as well as command-specific flags.
3838
3. `SlackTracerId` - trace IDs to verify CLI command output
39-
- see available exported IDs on `SlackTracerId` object
40-
- to enable the CLI to show this output, any CLI commands executed by this library are invoked with the environment variable set: `SLACK_TEST_TRACE=true`
39+
- see available exported IDs on `SlackTracerId` object
40+
- to enable the CLI to show this output, any CLI commands executed by this library are invoked with the environment variable set: `SLACK_TEST_TRACE=true`
4141

4242
```ts
4343
// Import available objects from the package

0 commit comments

Comments
 (0)