You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/speakeasy-reference/cli/run.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,22 @@
1
-
# run
1
+
# run
2
+
`speakeasy run`
2
3
3
-
`speakeasy run`
4
4
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
6
6
7
7
## Details
8
8
9
-
# Run
10
-
11
-
Execute the workflow(s) defined in your `.speakeasy/workflow.yaml` file.
9
+
# Run
10
+
Execute the workflow(s) defined in your `.speakeasy/workflow.yaml` file.
12
11
13
12
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.
14
13
15
14
A full workflow is capable of running the following:
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
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
22
20
23
21
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.
24
22
@@ -38,7 +36,7 @@ speakeasy run [flags]
38
36
-i, --installationURL string the language specific installation URL for installation instructions if the SDK is not published to a package manager
39
37
--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")
40
38
--minimal only run the steps that are strictly necessary to generate the SDK
41
-
-o, --output string What to output while running (available options: [summary, console, mermaid]) (default "summary")
39
+
-o, --output string What to output while running (default "summary")
42
40
--registry-tags strings tags to apply to the speakeasy registry bundle (comma-separated list)
43
41
-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
44
42
-b, --repo-subdir string the subdirectory of the repository where the SDK is located in the repo, helps with documentation generation
@@ -62,4 +60,4 @@ speakeasy run [flags]
62
60
63
61
### Parent Command
64
62
65
-
-[speakeasy](/docs/speakeasy-reference/cli/getting-started) - The Speakeasy CLI tool provides access to the Speakeasy.com platform
63
+
*[speakeasy](/docs/speakeasy-reference/cli/getting-started) - The Speakeasy CLI tool provides access to the Speakeasy.com platform
0 commit comments