mirror of
https://github.com/containers/podman.git
synced 2025-08-02 01:09:21 +08:00

Allow automatic generation for shell completion scripts with the internal cobra functions (requires v1.0.0+). This should replace the handwritten completion scripts and even adds support for fish. With this approach it is less likley that completions and code are out of sync. We can now create the scripts with - podman completion bash - podman completion zsh - podman completion fish To test the completion run: source <(podman completion bash) The same works for podman-remote and podman --remote and it will complete your remote containers/images with the correct endpoints values from --url/--connection. The completion logic is written in go and provided by the cobra library. The completion functions lives in `cmd/podman/completion/completion.go`. The unit test at cmd/podman/shell_completion_test.go checks if each command and flag has an autocompletion function set. This prevents that commands and flags have no shell completion set. This commit does not replace the current autocompletion scripts. Closes #6440 Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
59 lines
1.8 KiB
Go
59 lines
1.8 KiB
Go
package main
|
|
|
|
import (
|
|
"os"
|
|
|
|
"github.com/containers/common/pkg/auth"
|
|
"github.com/containers/common/pkg/completion"
|
|
"github.com/containers/image/v5/types"
|
|
"github.com/containers/podman/v2/cmd/podman/common"
|
|
"github.com/containers/podman/v2/cmd/podman/registry"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/containers/podman/v2/pkg/registries"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
logoutOptions = auth.LogoutOptions{}
|
|
logoutCommand = &cobra.Command{
|
|
Use: "logout [options] [REGISTRY]",
|
|
Short: "Logout of a container registry",
|
|
Long: "Remove the cached username and password for the registry.",
|
|
RunE: logout,
|
|
Args: cobra.MaximumNArgs(1),
|
|
ValidArgsFunction: common.AutocompleteRegistries,
|
|
Example: `podman logout quay.io
|
|
podman logout --authfile dir/auth.json quay.io
|
|
podman logout --all`,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
// Note that the local and the remote client behave the same: both
|
|
// store credentials locally while the remote client will pass them
|
|
// over the wire to the endpoint.
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: logoutCommand,
|
|
})
|
|
flags := logoutCommand.Flags()
|
|
|
|
// Flags from the auth package.
|
|
flags.AddFlagSet(auth.GetLogoutFlags(&logoutOptions))
|
|
|
|
// Add flag completion
|
|
completion.CompleteCommandFlags(logoutCommand, auth.GetLogoutFlagsCompletions())
|
|
|
|
logoutOptions.Stdout = os.Stdout
|
|
logoutOptions.AcceptUnspecifiedRegistry = true
|
|
}
|
|
|
|
// Implementation of podman-logout.
|
|
func logout(cmd *cobra.Command, args []string) error {
|
|
sysCtx := types.SystemContext{
|
|
AuthFilePath: logoutOptions.AuthFile,
|
|
SystemRegistriesConfPath: registries.SystemRegistriesConfPath(),
|
|
}
|
|
return auth.Logout(&sysCtx, &logoutOptions, args)
|
|
}
|