Skip to content

cmd/{workshop, sdk}: add command aliases - #1145

Open
jnsgruk wants to merge 7 commits into
canonical:mainfrom
jnsgruk:cmd-aliases
Open

jnsgruk wants to merge 7 commits into
canonical:mainfrom
jnsgruk:cmd-aliases

Conversation

@jnsgruk

@jnsgruk jnsgruk commented Nov 10, 2026 •

Copy link
Copy Markdown
Member

Adds a number of command aliases to the project:

  • workshop ls -> workshop list
  • workshop rm -> workshop remove
  • workshop sh -> workshop shell
  • workshop ok -> workshop okay
  • sdk ls -> sdk list
Details

Self-review quick check

  • Make decisions that cost a lot to reverse explicit in the PR description.
  • Avoid nested conditions.
  • Delete dead code and redundant comments.
  • Normalise symmetries by sticking to doing identical things identically.
  • Check that coupled code elements, files, and directories are adjacent. For example, test data is stored as close as possible to a test.
  • Put variable declaration and initialisation together.
  • Divide large expressions into digestable and self-explanatory ones. Use multiple variables if required.
  • Put a blank line between two logically different chunks of code.
  • Follow the style guide for new error messages.

Docs

Procedure:

  • I have checked and added or updated relevant documentation.
  • I have checked and added or updated relevant release notes.
  • I have included the technical author in the review.

Content:

  • Headings and titles accurately describe the content.
  • New and updated pages include correct metadata.
  • Documentation tests are added or updated where applicable (for tutorial/ and how-to/ sections).
  • Documentation follows the style guide.
  • If needed, docs/.coverage.yaml updated, coverage tags added (.. artefact).

Or:

  • I confirm the PR has no implications for documentation.

@jnsgruk

jnsgruk commented Nov 10, 2026

Copy link
Copy Markdown
Member Author

I've not updated the release notes, since there isn't yet an "unreleased" or "draft" section, but happy to if required.

@jnsgruk jnsgruk changed the title Cmd aliases cmd/workshop: add ls and rm command aliases Nov 10, 2026

@jonathan-conder jonathan-conder left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Partially fixes #860. I think we should do sdk ls as well, for consistency

Comment thread cmd/workshop/list.go Resolved
@jnsgruk jnsgruk linked an issue Nov 10, 2026 that may be closed by this pull request
@jnsgruk jnsgruk changed the title cmd/workshop: add ls and rm command aliases cmd/{workshop, sdk}: add command aliases Nov 10, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add common command aliases: ls, sh, rm, ok

2 participants