File tree Expand file tree Collapse file tree 4 files changed +115
-1
lines changed
docs/speakeasy-reference/cli Expand file tree Collapse file tree 4 files changed +115
-1
lines changed Original file line number Diff line number Diff line change 1+ # context
2+ ` speakeasy agent context `
3+
4+
5+ Browse agent context documentation
6+
7+ ## Details
8+
9+ Browse the embedded agent context filesystem. Provides AI agents with structured access to Speakeasy documentation.
10+
11+ ## Usage
12+
13+ ```
14+ speakeasy agent context [path] [flags]
15+ ```
16+
17+ ### Options
18+
19+ ```
20+ -A, --after int Lines of context after grep matches (overrides -C for after)
21+ -B, --before int Lines of context before grep matches (overrides -C for before)
22+ -C, --context int Lines of context around grep matches (default 2)
23+ -g, --grep string Search content for a literal string
24+ -h, --help help for context
25+ --json Output in JSON format
26+ -l, --list List matching file paths only (with --grep), or list all doc paths (without --grep)
27+ -e, --regex Treat --grep pattern as a regular expression
28+ ```
29+
30+ ### Options inherited from parent commands
31+
32+ ```
33+ --logLevel string the log level (available options: [info, warn, error]) (default "info")
34+ ```
35+
36+ ### Parent Command
37+
38+ * [ speakeasy agent] ( /docs/speakeasy-reference/cli/agent ) - Docs & guided workflows for AI coding agents (start here: speakeasy agent context)
Original file line number Diff line number Diff line change 1+ # feedback
2+ ` speakeasy agent feedback `
3+
4+
5+ Submit feedback on agent context content
6+
7+ ## Details
8+
9+ Submit feedback on Speakeasy agent context documentation. Feedback is sent anonymously unless you are authenticated.
10+
11+ ## Usage
12+
13+ ```
14+ speakeasy agent feedback [flags]
15+ ```
16+
17+ ### Options
18+
19+ ```
20+ --context-path string The agent-context path this feedback relates to
21+ -h, --help help for feedback
22+ -m, --message string The feedback message
23+ -t, --type string Feedback type: agent_context or general (default "agent_context")
24+ ```
25+
26+ ### Options inherited from parent commands
27+
28+ ```
29+ --logLevel string the log level (available options: [info, warn, error]) (default "info")
30+ ```
31+
32+ ### Parent Command
33+
34+ * [ speakeasy agent] ( /docs/speakeasy-reference/cli/agent ) - Docs & guided workflows for AI coding agents (start here: speakeasy agent context)
Original file line number Diff line number Diff line change 1+ ---
2+ asIndexPage : true
3+ ---
4+
5+ # agent
6+ ` speakeasy agent `
7+
8+
9+ Docs & guided workflows for AI coding agents (start here: speakeasy agent context)
10+
11+ ## Details
12+
13+ Commands for AI agents interacting with Speakeasy. Run 'speakeasy agent context' for structured documentation.
14+
15+ ## Usage
16+
17+ ```
18+ speakeasy agent [flags]
19+ ```
20+
21+ ### Options
22+
23+ ```
24+ -h, --help help for agent
25+ ```
26+
27+ ### Options inherited from parent commands
28+
29+ ```
30+ --logLevel string the log level (available options: [info, warn, error]) (default "info")
31+ ```
32+
33+ ### Parent Command
34+
35+ * [ speakeasy] ( /docs/speakeasy-reference/cli/getting-started ) - The Speakeasy CLI tool provides access to the Speakeasy.com platform
36+ ### Sub Commands
37+
38+ * [ speakeasy agent context] ( /docs/speakeasy-reference/cli/agent/context ) - Browse agent context documentation
39+ * [ speakeasy agent feedback] ( /docs/speakeasy-reference/cli/agent/feedback ) - Submit feedback on agent context content
Original file line number Diff line number Diff line change @@ -10,10 +10,12 @@ The Speakeasy CLI tool provides access to the Speakeasy.com platform
1010
1111## Details
1212
13- # Speakeasy
13+ # Speakeasy
1414
1515A CLI tool for interacting with the [ Speakeasy platform] ( https://www.speakeasy.com/ ) and its APIs.
1616
17+ AI Agents: run ** speakeasy agent context** for structured documentation and project guidance.
18+
1719Use this CLI to:
1820- Lint and validate OpenAPI specs
1921- Create, manage, and run Speakeasy workflows
@@ -46,6 +48,7 @@ speakeasy [flags]
4648
4749### Sub Commands
4850
51+ * [ speakeasy agent] ( /docs/speakeasy-reference/cli/agent ) - Docs & guided workflows for AI coding agents (start here: speakeasy agent context)
4952* [ speakeasy ask] ( /docs/speakeasy-reference/cli/ask ) - Starts a conversation with Speakeasy trained AI
5053* [ speakeasy auth] ( /docs/speakeasy-reference/cli/auth ) - Authenticate the CLI
5154* [ speakeasy billing] ( /docs/speakeasy-reference/cli/billing ) - Manage billing related operations
You can’t perform that action at this time.
0 commit comments