Skip to content

Commit 0e126b6

Browse files
committed
Sync open source content 🐝 (from 74a7a83db9fe3c07f3fed98ca5d9b13804c1fa7c)
1 parent ff3fcbb commit 0e126b6

File tree

1 file changed

+14
-12
lines changed
  • docs/speakeasy-reference/cli

1 file changed

+14
-12
lines changed

docs/speakeasy-reference/cli/run.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
# run
2-
`speakeasy run`
1+
# run
32

3+
`speakeasy run`
44

5-
Run all the workflows defined in your workflow.yaml file. This can include multiple SDK generations from different OpenAPI sources
5+
Run all the workflows defined in your workflow.yaml file. This can include multiple SDK generations from different OpenAPI sources
66

77
## Details
88

9-
# Run
10-
Execute the workflow(s) defined in your `.speakeasy/workflow.yaml` file.
9+
# Run
10+
11+
Execute the workflow(s) defined in your `.speakeasy/workflow.yaml` file.
1112

1213
A workflow can consist of multiple targets that define a source OpenAPI document that can be downloaded from a URL, exist as a local file, or be created via merging multiple OpenAPI documents together and/or overlaying them with an OpenAPI overlay document.
1314

1415
A full workflow is capable of running the following:
15-
- Downloading source OpenAPI documents from a URL
16-
- Merging multiple OpenAPI documents together
17-
- Overlaying OpenAPI documents with an OpenAPI overlay document
18-
- Generating one or many SDKs from the resulting OpenAPI document
19-
- Compiling the generated SDKs
16+
17+
- Downloading source OpenAPI documents from a URL
18+
- Merging multiple OpenAPI documents together
19+
- Overlaying OpenAPI documents with an OpenAPI overlay document
20+
- Generating one or many SDKs from the resulting OpenAPI document
21+
- Compiling the generated SDKs
2022

2123
If `speakeasy run` is run without any arguments it will run either the first target in the workflow or the first source in the workflow if there are no other targets or sources, otherwise it will prompt you to select a target or source to run.
2224

@@ -36,7 +38,7 @@ speakeasy run [flags]
3638
-i, --installationURL string the language specific installation URL for installation instructions if the SDK is not published to a package manager
3739
--installationURLs string a map from target ID to installation URL for installation instructions if the SDK is not published to a package manager (default "null")
3840
--minimal only run the steps that are strictly necessary to generate the SDK
39-
-o, --output string What to output while running (default "summary")
41+
-o, --output string What to output while running (available options: [summary, console, mermaid]) (default "summary")
4042
--registry-tags strings tags to apply to the speakeasy registry bundle (comma-separated list)
4143
-r, --repo string the repository URL for the SDK, if the published (-p) flag isn't used this will be used to generate installation instructions
4244
-b, --repo-subdir string the subdirectory of the repository where the SDK is located in the repo, helps with documentation generation
@@ -60,4 +62,4 @@ speakeasy run [flags]
6062

6163
### Parent Command
6264

63-
* [speakeasy](/docs/speakeasy-reference/cli/getting-started) - The Speakeasy CLI tool provides access to the Speakeasy.com platform
65+
- [speakeasy](/docs/speakeasy-reference/cli/getting-started) - The Speakeasy CLI tool provides access to the Speakeasy.com platform

0 commit comments

Comments
 (0)