Skip to content

Commit 7de1b0f

Browse files
committed
Sync open source content 🐝 (from 20f7f20c1b34a55b59694d70ab24e374242ab391)
1 parent 8088b96 commit 7de1b0f

File tree

3 files changed

+26
-7
lines changed

3 files changed

+26
-7
lines changed

docs/speakeasy-reference/cli/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ speakeasy [flags]
5757
* [speakeasy merge](/docs/speakeasy-reference/cli/merge) - Merge multiple OpenAPI documents into a single document
5858
* [speakeasy openapi](/docs/speakeasy-reference/cli/openapi) - Utilities for working with OpenAPI documents
5959
* [speakeasy overlay](/docs/speakeasy-reference/cli/overlay) - Work with OpenAPI Overlays
60-
* [speakeasy pull](/docs/speakeasy-reference/cli/pull) - pull a spec from the registry
60+
* [speakeasy pull](/docs/speakeasy-reference/cli/pull) - Pull a spec from the registry or list available specs/tags
6161
* [speakeasy quickstart](/docs/speakeasy-reference/cli/quickstart) - Guided setup to help you create a new SDK in minutes.
6262
* [speakeasy repro](/docs/speakeasy-reference/cli/repro) - Reproduce a failed generation locally
6363
* [speakeasy run](/docs/speakeasy-reference/cli/run) - Run all the workflows defined in your workflow.yaml file. This can include multiple SDK generations from different OpenAPI sources

docs/speakeasy-reference/cli/pull.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,26 @@
22
`speakeasy pull`
33

44

5-
pull a spec from the registry
5+
Pull a spec from the registry or list available specs/tags
66

77
## Details
88

9-
pull a spec from the registry
9+
Pull a spec from the registry or list available specs/tags.
10+
11+
Examples:
12+
# List all available specs in your workspace
13+
speakeasy pull --list
14+
speakeasy pull --list --format=json
15+
16+
# List available tags for a specific spec
17+
speakeasy pull --spec=my-api --list-tags
18+
speakeasy pull --spec=my-api --list-tags --format=json
19+
20+
# Pull a spec to the current directory
21+
speakeasy pull --spec=my-api --revision=latest
22+
23+
# Pull a specific revision to a custom directory
24+
speakeasy pull --spec=my-api --revision=v1.0.0 --output-dir=./specs
1025

1126
## Usage
1227

@@ -17,10 +32,13 @@ speakeasy pull [flags]
1732
### Options
1833

1934
```
35+
--format string Output format for --list and --list-tags (table, json) (default "table")
2036
-h, --help help for pull
21-
--output-dir string The directory to output the image to (default "/home/runner/work/speakeasy/speakeasy/speakeasy")
22-
--revision string The revision to pull (default "latest")
23-
--spec string The name of the spec to want to pull
37+
--list List all available specs in your workspace (non-interactive)
38+
--list-tags List available tags for a spec (requires --spec)
39+
--output-dir string The directory to output the spec bundle to (default "/home/runner/work/speakeasy/speakeasy/speakeasy")
40+
--revision string The revision/tag to pull (default "latest")
41+
--spec string The name of the spec to pull or list tags for
2442
```
2543

2644
### Options inherited from parent commands

docs/speakeasy-reference/cli/quickstart.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,12 @@ speakeasy quickstart [flags]
2020
-f, --from string template to use for the quickstart command.
2121
Create a new sandbox at https://app.speakeasy.com/sandbox
2222
-h, --help help for quickstart
23+
--init-git initialize a git repository in the output directory
2324
-n, --name string SDK name in PascalCase (e.g., "MyCompanySDK"). Users access SDK methods with myCompanySDK.DoThing()
2425
-o, --out-dir string output directory for the quickstart command
2526
--output string how to display output (available options: [summary, console, mermaid]) (default "summary")
2627
-p, --package-name string package name for the generated SDK (e.g., "my-company-sdk" for npm, Go module path for Go)
27-
-s, --schema string local filepath, URL, or registry reference (org/workspace/namespace) for the OpenAPI schema
28+
-s, --schema string local filepath, URL, or registry reference for the OpenAPI schema (e.g., ./spec.yaml, https://..., namespace, org/workspace/namespace@tag)
2829
--skip-compile skip compilation during generation after setup
2930
-t, --target string generation target (available options: [csharp, go, java, mcp-typescript, php, postman, python, ruby, terraform, typescript, unity])
3031
```

0 commit comments

Comments
 (0)