GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — feat/docs: generate docs for legacy and urfave commands by burmudar · Pull Request #1304 · sourcegraph/src-cli

Conversation

@burmudar

@burmudar burmudar commented Apr 28, 2026

Copy link
Copy Markdown
Contributor

Update docgen to render migrated urface/cli commands in the expected help doc template

Closes CPL-381

Note

There are some formatting issues with Commands and Subcommands which have no flags. I plan to address this in a follow up

Test plan

src doc -o doctest/

abc/index.md

# `src abc`

manages agentic batch changes.



## Usage

sh
$ src abc [command options]


## Subcommands

* [`variables`](variables/index.md)

abc/variables/index.md

# `src abc variables`

manage workflow instance variables.



## Usage

sh
$ src abc variables [command options]


## Subcommands

* [`delete`](delete.md)
* [`set`](set.md)


abc/variables/delete.md

# `src abc variables delete`

Delete variables on a workflow instance.

Delete workflow instance variables

Examples:

  Delete a variable from a workflow instance:

	    $ src abc variables delete QWdlbnRpY1dvcmtmbG93SW5zdGFuY2U6MQ== approval

  Delete multiple variables in one request:

	    $ src abc variables delete QWdlbnRpY1dvcmtmbG93SW5zdGFuY2U6MQ== --var approval --var checkpoints

## Usage

sh
$ src abc variables delete [options] <workflow-instance-id> [<name> ...]


## Flags

| Name | Description | Default Value |
|------|-------------|---------------|
| `---dump-requests` | Log GraphQL requests and responses to stdout | `false`|
| `---get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false`|
| `---insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false`|
| `---trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false`|
| `---user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true`|
| `---var` | Variable name to delete. Repeat for multiple names. | ``|

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@burmudar
burmudar requested review from a team and eseliger April 28, 2026 14:34
@burmudar burmudar self-assigned this Apr 28, 2026
keegancsmith
keegancsmith approved these changes Apr 28, 2026
View reviewed changes
Comment thread cmd/src/doc.go Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread lib/docgen/markdown.go Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread lib/docgen/markdown.go Resolved

Uh oh!

There was an error while loading. Please reload this page.

@burmudar
feat/docgen: generate docs for legacy and urfave commands
9d95ea0
@burmudar
burmudar force-pushed the wb/update-docgen branch from 0d2336e to 9d95ea0 Compare April 29, 2026 09:50
burmudar added 2 commits April 29, 2026 11:57
@burmudar
Merge branch 'main' into wb/update-docgen
93ff486
@burmudar
Merge branch 'main' into wb/update-docgen
f34b51e
@burmudar
burmudar enabled auto-merge (squash) April 30, 2026 12:14
@burmudar
burmudar merged commit 0d9c9db into main Apr 30, 2026
9 checks passed

Uh oh!

There was an error while loading. Please reload this page.

@burmudar
burmudar deleted the wb/update-docgen branch April 30, 2026 12:20
This was referenced Sep 9, 2026
fix/doc: Add missing commands to helper text #1375
Merged
fix/help: Generate help command list from registered commands #1377
Merged
docs/cli: Add missing doc pages for src-cli commands sourcegraph/docs#1889
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@keegancsmith keegancsmith keegancsmith approved these changes
@eseliger eseliger Awaiting requested review from eseliger

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@burmudar burmudar

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@burmudar @keegancsmith
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.