Command-line tool: pipectl CLI docs reference removed pipectl init command, missing migrate and plugin
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 1.4k
- Forks
- 364
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 84
Description
What would you like to be added
Update the pipectl CLI documentation in docs-dev to match the current source code.
Files that need changes
-
docs/content/en/docs-dev/user-guide/command-line-tool.md- Line 151: Remove
initfrom the "Available Commands" help output - Lines 145-155: Add
migrate,plugin, andcompletionto the "Available Commands" help output - Lines 360-390: Remove the "Generating an application config" section (documents removed
pipectl initcommand) - Add a new section documenting
pipectl migrate application-config(the replacement forinit) - Add a new section documenting
pipectl plugin push(currently undocumented)
- Line 151: Remove
-
docs/content/en/docs-dev/feature-status/_index.md- Line 107: The "Pipectl" feature links to command-line-tool docs but still references
pipectl initas a feature. Update the wording to reference the current migration workflow or make it more generic.
- Line 107: The "Pipectl" feature links to command-line-tool docs but still references
-
docs/content/en/docs-v1.0.x/user-guide/command-line-tool.md- Apply the same changes as the
docs-devversion if this file exists and contains the same outdated content.
- Apply the same changes as the
Details
pipectl init was removed in commit 81586152f (#5958). Running it now returns:
2026/05/08 15:55:20 unknown command "init" for "pipectl"
Current pipectl --help output:
Available Commands:
application Manage application resources.
completion Generate the autocompletion script for the specified shell
deployment Manage deployment resources.
encrypt Encrypt the plaintext entered in either stdin or the --input-file flag.
event Manage event resources.
help Help about any command
migrate Do migration tasks.
piped Manage piped resources.
plan-preview Show plan preview against the specified commit.
plugin Do plugin tasks.
version Print the information of current binary.
pipectl migrate application-config is the replacement for pipectl init. It converts v0 application configs to the v1 format.
Supported flags:
--config-files--dirs--applications
(Defined in pkg/app/pipectl/cmd/migrate/application_config.go)
pipectl plugin push pushes plugin binaries to an OCI registry.
Required flags:
--files--tag--registry--repository
(Defined in pkg/app/pipectl/cmd/plugin/push.go)
This command is currently undocumented.
Why is this needed
Users following the official docs currently hit a dead end because pipectl init no longer exists in the current release. In addition, plugin authors have no discoverable documentation for pipectl plugin push, even though it is part of the CLI.
- docs
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/content/en/docs-dev/user-guide/command-line-tool.md and compare its help output with the current pipectl source in pkg/app/pipectl/cmd/migrate/application_config.go and pkg/app/pipectl/cmd/plugin/push.go. Check docs/content/en/docs-dev/feature-status/_index.md and the v1.0.x command-line documentation for the same outdated references. Done means both command-line docs describe migrate application-config and plugin push, remove init, and the feature wording no longer presents init as current.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 74/100