Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ labels: type/bug,status/needs-triage
### Description
<!--- Please provide a thorough description of the bug you are experiencing here. --->

### PingCLI Version
### Ping CLI Version
<!--- Check the version you have configured with `pingcli --version`. If you are not running the latest version of the cli, please upgrade because your issue may have already been fixed. -->

### Affected Command(s)
Expand All @@ -29,7 +29,7 @@ labels: type/bug,status/needs-triage
<!--- Please provide your debug output with `PING_LOG_LEVEL=DEBUG` enabled on your relevant command(s) -->

### Panic Output
<!--- If PingCLI produced a panic, please provide your debug output from the GO panic -->
<!--- If Ping CLI produced a panic, please provide your debug output from the GO panic -->

### Expected Behavior
<!--- What should have happened? -->
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ labels: type/question,status/needs-triage

### Description

<!-- Please provide details of your question within the context of PingCLI usage or documentation here -->
<!-- Please provide details of your question within the context of Ping CLI usage or documentation here -->

### Additional Context

<!-- Use this space for any relevant background information including PingCLI version, Terraform Providers/Version -->
<!-- Use this space for any relevant background information including Ping CLI version, Terraform Providers/Version -->

### References

Expand Down
8 changes: 4 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ test: --checktestenvvars --test-cmd --test-internal-commands --test-internal-con

--checktestenvvars:
@echo -n "Checking for required environment variables to run pingcli tests..."
@test -n "$$TEST_PINGONE_ENVIRONMENT_ID" || { echo " FAILED"; echo "TEST_PINGONE_ENVIRONMENT_ID environment variable is not set.\n\nCreate/Specify an unconfigured PingOne environment to test PingCLI with. The following services are required: PingOne SSO, PingOne MFA, PingOne Protect, PingOne DaVinci, PingOne Authorize, and PingFederate"; exit 1; }
@test -n "$$TEST_PINGONE_REGION_CODE" || { echo " FAILED"; echo "TEST_PINGONE_REGION_CODE environment variable is not set.\n\nCreate/Specify an unconfigured PingOne environment to test PingCLI with. The following services are required: PingOne SSO, PingOne MFA, PingOne Protect, PingOne DaVinci, PingOne Authorize, and PingFederate"; exit 1; }
@test -n "$$TEST_PINGONE_WORKER_CLIENT_ID" || { echo " FAILED"; echo "TEST_PINGONE_WORKER_CLIENT_ID environment variable is not set.\n\nCreate/Specify a worker applicaiton in the unconfigured PingOne environment with all admin roles to test PingCLI with"; exit 1; }
@test -n "$$TEST_PINGONE_WORKER_CLIENT_SECRET" || { echo " FAILED"; echo "TEST_PINGONE_WORKER_CLIENT_SECRET environment variable is not set.\n\nCreate/Specify a worker applicaiton in an unconfigured PingOne environment with all admin roles to test PingCLI with"; exit 1; }
@test -n "$$TEST_PINGONE_ENVIRONMENT_ID" || { echo " FAILED"; echo "TEST_PINGONE_ENVIRONMENT_ID environment variable is not set.\n\nCreate/Specify an unconfigured PingOne environment to test Ping CLI with. The following services are required: PingOne SSO, PingOne MFA, PingOne Protect, PingOne DaVinci, PingOne Authorize, and PingFederate"; exit 1; }
@test -n "$$TEST_PINGONE_REGION_CODE" || { echo " FAILED"; echo "TEST_PINGONE_REGION_CODE environment variable is not set.\n\nCreate/Specify an unconfigured PingOne environment to test Ping CLI with. The following services are required: PingOne SSO, PingOne MFA, PingOne Protect, PingOne DaVinci, PingOne Authorize, and PingFederate"; exit 1; }
@test -n "$$TEST_PINGONE_WORKER_CLIENT_ID" || { echo " FAILED"; echo "TEST_PINGONE_WORKER_CLIENT_ID environment variable is not set.\n\nCreate/Specify a worker applicaiton in the unconfigured PingOne environment with all admin roles to test Ping CLI with"; exit 1; }
@test -n "$$TEST_PINGONE_WORKER_CLIENT_SECRET" || { echo " FAILED"; echo "TEST_PINGONE_WORKER_CLIENT_SECRET environment variable is not set.\n\nCreate/Specify a worker applicaiton in an unconfigured PingOne environment with all admin roles to test Ping CLI with"; exit 1; }
@echo " SUCCESS"

--test-cmd:
Expand Down
6 changes: 3 additions & 3 deletions cmd/plugin/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

const (
addPluginCommandExamples = ` Add a plugin to use with PingCLI.
addPluginCommandExamples = ` Add a plugin to use with Ping CLI.
pingcli plugin add pingcli-plugin-executable`
)

Expand All @@ -19,9 +19,9 @@ func NewPluginAddCommand() *cobra.Command {
Args: common.ExactArgs(1),
DisableFlagsInUseLine: true, // We write our own flags in @Use attribute
Example: addPluginCommandExamples,
Long: `Add a plugin to use with PingCLI.`,
Long: `Add a plugin to use with Ping CLI.`,
RunE: pluginAddRunE,
Short: "Add a plugin to use with PingCLI",
Short: "Add a plugin to use with Ping CLI",
Use: "add plugin-executable",
}

Expand Down
6 changes: 3 additions & 3 deletions cmd/plugin/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

const (
listPluginCommandExamples = ` List all plugins currently in use with PingCLI.
listPluginCommandExamples = ` List all plugins currently in use with Ping CLI.
pingcli plugin list`
)

Expand All @@ -19,9 +19,9 @@ func NewPluginListCommand() *cobra.Command {
Args: common.ExactArgs(0),
DisableFlagsInUseLine: true, // We write our own flags in @Use attribute
Example: listPluginCommandExamples,
Long: `List all plugins currently in use with PingCLI.`,
Long: `List all plugins currently in use with Ping CLI.`,
RunE: pluginListRunE,
Short: "List all plugins currently in use with PingCLI",
Short: "List all plugins currently in use with Ping CLI",
Use: "list",
}

Expand Down
4 changes: 2 additions & 2 deletions cmd/plugin/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import (

func NewPluginCommand() *cobra.Command {
cmd := &cobra.Command{
Long: `Manage PingCLI plugins.`,
Short: "Manage PingCLI plugins.",
Long: `Manage Ping CLI plugins.`,
Short: "Manage Ping CLI plugins.",
Use: "plugin",
}

Expand Down
6 changes: 3 additions & 3 deletions cmd/plugin/remove.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
)

const (
removePluginCommandExamples = ` Remove a plugin from PingCLI.
removePluginCommandExamples = ` Remove a plugin from Ping CLI.
pingcli plugin remove pingcli-plugin-executable`
)

Expand All @@ -19,9 +19,9 @@ func NewPluginRemoveCommand() *cobra.Command {
Args: common.ExactArgs(1),
DisableFlagsInUseLine: true, // We write our own flags in @Use attribute
Example: removePluginCommandExamples,
Long: `Remove a plugin from PingCLI.`,
Long: `Remove a plugin from Ping CLI.`,
RunE: pluginRemoveRunE,
Short: "Remove a plugin from PingCLI",
Short: "Remove a plugin from Ping CLI",
Use: "remove plugin-executable",
}

Expand Down
4 changes: 2 additions & 2 deletions examples/plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PingCLI Plugin Development Guide
# Ping CLI Plugin Development Guide

Welcome to the developer guide for creating `pingcli` plugins! This document provides all the information you need to build, test, and distribute your own custom commands to extend the functionality of the `pingcli` tool.

Expand Down Expand Up @@ -27,7 +27,7 @@ The `pingcli` plugin system allows developers to create new commands that integr

- **Go 1.24+** (for building Go plugins)
- [HashiCorp go-plugin](https://github.com/hashicorp/go-plugin) (used by both host and plugin)
- **PingCLI v0.7.0+** installed and configured
- **Ping CLI v0.7.0+** installed and configured

## How Plugins Work

Expand Down
2 changes: 1 addition & 1 deletion examples/plugin/plugin.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Copyright © 2025 Ping Identity Corporation

// Package 'plugin' provides an example implementation of a PingCLI command plugin.
// Package 'plugin' provides an example implementation of a Ping CLI command plugin.
//
// It demonstrates the required structure and interfaces for building a new
// command that can be dynamically loaded and executed by the main pingcli
Expand Down
2 changes: 1 addition & 1 deletion internal/commands/license/license_internal.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ func runLicenseRequest(ctx context.Context, product, version, devopsUser, devops

req.Header.Set("Devops-User", devopsUser)
req.Header.Set("Devops-Key", devopsKey)
req.Header.Set("Devops-App", "PingCLI")
req.Header.Set("Devops-App", "Ping CLI")
req.Header.Set("Devops-Purpose", "download-license")
req.Header.Set("Product", product)
req.Header.Set("Version", version)
Expand Down
2 changes: 1 addition & 1 deletion internal/output/output.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ func SystemError(message string, fields map[string]interface{}) {
l := logger.Get()
systemMsg := fmt.Sprintf(`FATAL: %s

This is a bug in PingCLI and needs reporting to our team.
This is a bug in Ping CLI and needs reporting to our team.

Please raise an issue at https://github.com/pingidentity/pingcli`,
message)
Expand Down
6 changes: 3 additions & 3 deletions internal/plugins/plugins.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@
Level: hclog.Debug,
})

// PingCLI is the host process. Start the plugin process
// Ping CLI is the host process. Start the plugin process
client := hplugin.NewClient(&hplugin.ClientConfig{
HandshakeConfig: grpc.HandshakeConfig,
Plugins: grpc.PluginMap,
Cmd: exec.Command(pluginExecutable),

Check failure on line 79 in internal/plugins/plugins.go

View workflow job for this annotation

GitHub Actions / golangci-lint

os/exec.Command must not be called. use os/exec.CommandContext (noctx)
AllowedProtocols: []hplugin.Protocol{
hplugin.ProtocolGRPC,
},
Expand All @@ -95,7 +95,7 @@
return nil, fmt.Errorf("failed to create Plugin RPC client: %w", err)
}

// All PingCLI plugins are expected to serve the ENUM_PINGCLI_COMMAND_GRPC plugin via
// All Ping CLI plugins are expected to serve the ENUM_PINGCLI_COMMAND_GRPC plugin via
// the PluginMap within the plugin.Serve() method.
// Non-Golang plugins unable to use the shared grpc module should supply the
// raw value of ENUM_PINGCLI_COMMAND_GRPC "pingcli_command_grpc" for the PluginMap key.
Expand Down Expand Up @@ -126,7 +126,7 @@
// The configuration method is defined by the protobuf definition.
// The plugin should return relevant cobra command information
// even if the plugin does not use cobra commands internally.
// This allows the host process PingCLI to present the plugin command
// This allows the host process Ping CLI to present the plugin command
// in the help output.
resp, err := plugin.Configuration()
if err != nil {
Expand Down
Loading