Skip to content

feat: standardized output formats #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
varonix0 merged 4 commits into from
Oct 9, 2025
Merged

feat: standardized output formats #25

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5157570
feat: output formats
varonix0 Oct 3, 2025
d71901e
feat: output format, folder support
varonix0 Oct 3, 2025
648efa0
requested changes
varonix0 Oct 4, 2025
d0e1c74
requested changes
varonix0 Oct 7, 2025
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
1 change: 1 addition & 0 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ require (
dario.cat/mergo v1.0.1 // indirect
github.com/Masterminds/goutils v1.1.1 // indirect
github.com/Masterminds/semver/v3 v3.3.0 // indirect
github.com/agnivade/levenshtein v1.2.1 // indirect
github.com/alessio/shellescape v1.4.1 // indirect
github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef // indirect
github.com/aws/aws-sdk-go-v2 v1.27.2 // indirect
Expand Down
2 changes: 2 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ github.com/Masterminds/semver/v3 v3.3.0 h1:B8LGeaivUe71a5qox1ICM/JLl0NqZSW5CHyL+
github.com/Masterminds/semver/v3 v3.3.0/go.mod h1:4V+yj/TJE1HU9XfppCwVMZq3I84lprf4nC11bSS5beM=
github.com/Masterminds/sprig/v3 v3.3.0 h1:mQh0Yrg1XPo6vjYXgtf5OtijNAKJRNcTdOOGZe3tPhs=
github.com/Masterminds/sprig/v3 v3.3.0/go.mod h1:Zy1iXRYNqNLUolqCpL4uhk6SHUMAOSCzdgBfDb35Lz0=
github.com/agnivade/levenshtein v1.2.1 h1:EHBY3UOn1gwdy/VbFwgo4cxecRznFk7fKWN1KOX7eoM=
github.com/agnivade/levenshtein v1.2.1/go.mod h1:QVVI16kDrtSuwcpd0p1+xMC6Z/VfhtCyDIjcwga4/DU=
github.com/alessio/shellescape v1.4.1 h1:V7yhSDDn8LP4lc4jS8pFkt0zCnzVJlG5JXy9BVKJUX0=
github.com/alessio/shellescape v1.4.1/go.mod h1:PZAiSCk0LJaZkiCSkPv8qIobYglO3FPpyFjDCtHLS30=
github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
Expand Down
113 changes: 95 additions & 18 deletions packages/cmd/dynamic_secrets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ func getDynamicSecretList(cmd *cobra.Command, args []string) {
util.HandleError(err, "Unable to parse path flag")
}

outputFormat, err := cmd.Flags().GetString("output")
if err != nil {
util.HandleError(err, "Unable to parse flag")
}

var infisicalToken string
httpClient, err := util.GetRestyClientWithCustomHeaders()
if err != nil {
Expand Down Expand Up @@ -123,7 +128,15 @@ func getDynamicSecretList(cmd *cobra.Command, args []string) {
util.HandleError(err, "To fetch dynamic secret root credentials details")
}

visualize.PrintAllDynamicRootCredentials(dynamicSecretRootCredentials)
if outputFormat != "" {
output, err := util.FormatOutput(outputFormat, dynamicSecretRootCredentials, nil)
if err != nil {
util.HandleError(err, "Unable to format output")
}
fmt.Print(output)
} else {
visualize.PrintAllDynamicRootCredentials(dynamicSecretRootCredentials)
}
Telemetry.CaptureEvent("cli-command:dynamic-secrets", posthog.NewProperties().Set("count", len(dynamicSecretRootCredentials)).Set("version", util.CLI_VERSION))
}

Expand Down Expand Up @@ -184,6 +197,11 @@ func createDynamicSecretLeaseByName(cmd *cobra.Command, args []string) {
util.HandleError(err, "Unable to parse flag")
}

outputFormat, err := cmd.Flags().GetString("output")
if err != nil {
util.HandleError(err, "Unable to parse flag")
}

var infisicalToken string
httpClient, err := util.GetRestyClientWithCustomHeaders()
if err != nil {
Expand Down Expand Up @@ -272,19 +290,29 @@ func createDynamicSecretLeaseByName(cmd *cobra.Command, args []string) {
util.HandleError(err, "To lease dynamic secret")
}

if plainOutput {
for key, value := range leaseCredentials {
if cred, ok := value.(string); ok {
fmt.Printf("%s=%s\n", key, cred)
}
if outputFormat != "" {

output, err := util.FormatOutput(outputFormat, leaseCredentials, nil)
if err != nil {
util.HandleError(err)
}
fmt.Print(output)
} else {
fmt.Println("Dynamic Secret Leasing")
fmt.Printf("Name: %s\n", dynamicSecretRootCredential.Name)
fmt.Printf("Provider: %s\n", dynamicSecretRootCredential.Type)
fmt.Printf("Lease ID: %s\n", leaseDetails.Id)
fmt.Printf("Expire At: %s\n", leaseDetails.ExpireAt.Local().Format("02-Jan-2006 03:04:05 PM"))
visualize.PrintAllDyamicSecretLeaseCredentials(leaseCredentials)
// plain output is deprecated is replaced by output=dotenv format, but remains for backwards compatibility
if plainOutput {
for key, value := range leaseCredentials {
if cred, ok := value.(string); ok {
fmt.Printf("%s=%s\n", key, cred)
}
}
} else {
fmt.Println("Dynamic Secret Leasing")
fmt.Printf("Name: %s\n", dynamicSecretRootCredential.Name)
fmt.Printf("Provider: %s\n", dynamicSecretRootCredential.Type)
fmt.Printf("Lease ID: %s\n", leaseDetails.Id)
fmt.Printf("Expire At: %s\n", leaseDetails.ExpireAt.Local().Format("02-Jan-2006 03:04:05 PM"))
visualize.PrintAllDyamicSecretLeaseCredentials(leaseCredentials)
}
}

Telemetry.CaptureEvent("cli-command:dynamic-secrets lease", posthog.NewProperties().Set("type", dynamicSecretRootCredential.Type).Set("version", util.CLI_VERSION))
Expand Down Expand Up @@ -335,6 +363,11 @@ func renewDynamicSecretLeaseByName(cmd *cobra.Command, args []string) {
util.HandleError(err, "Unable to parse path flag")
}

outputFormat, err := cmd.Flags().GetString("output")
if err != nil {
util.HandleError(err, "Unable to parse flag")
}

var infisicalToken string
httpClient, err := util.GetRestyClientWithCustomHeaders()
if err != nil {
Expand Down Expand Up @@ -404,8 +437,18 @@ func renewDynamicSecretLeaseByName(cmd *cobra.Command, args []string) {
util.HandleError(err, "To renew dynamic secret lease")
}

fmt.Println("Successfully renewed dynamic secret lease")
visualize.PrintAllDynamicSecretLeases([]infisicalSdkModels.DynamicSecretLease{leaseDetails})
if outputFormat != "" {

output, err := util.FormatOutput(outputFormat, leaseDetails, nil)
if err != nil {
util.HandleError(err, "Unable to format output")
}
fmt.Print(output)
} else {

fmt.Println("Successfully renewed dynamic secret lease")
visualize.PrintAllDynamicSecretLeases([]infisicalSdkModels.DynamicSecretLease{leaseDetails})
}

Telemetry.CaptureEvent("cli-command:dynamic-secrets lease renew", posthog.NewProperties().Set("version", util.CLI_VERSION))
}
Expand Down Expand Up @@ -450,6 +493,11 @@ func revokeDynamicSecretLeaseByName(cmd *cobra.Command, args []string) {
util.HandleError(err, "Unable to parse path flag")
}

outputFormat, err := cmd.Flags().GetString("output")
if err != nil {
util.HandleError(err, "Unable to parse flag")
}

var infisicalToken string
httpClient, err := util.GetRestyClientWithCustomHeaders()
if err != nil {
Expand Down Expand Up @@ -514,13 +562,21 @@ func revokeDynamicSecretLeaseByName(cmd *cobra.Command, args []string) {
EnvironmentSlug: environmentName,
LeaseId: dynamicSecretLeaseId,
})

if err != nil {
util.HandleError(err, "To revoke dynamic secret lease")
}

fmt.Println("Successfully revoked dynamic secret lease")
visualize.PrintAllDynamicSecretLeases([]infisicalSdkModels.DynamicSecretLease{leaseDetails})
if outputFormat != "" {
output, err := util.FormatOutput(outputFormat, leaseDetails, nil)
if err != nil {
util.HandleError(err, "Unable to format output")
}
fmt.Print(output)
} else {

fmt.Println("Successfully revoked dynamic secret lease")
visualize.PrintAllDynamicSecretLeases([]infisicalSdkModels.DynamicSecretLease{leaseDetails})
}

Telemetry.CaptureEvent("cli-command:dynamic-secrets lease revoke", posthog.NewProperties().Set("version", util.CLI_VERSION))
}
Expand Down Expand Up @@ -565,6 +621,11 @@ func listDynamicSecretLeaseByName(cmd *cobra.Command, args []string) {
util.HandleError(err, "Unable to parse path flag")
}

outputFormat, err := cmd.Flags().GetString("output")
if err != nil {
util.HandleError(err, "Unable to parse flag")
}

var infisicalToken string
httpClient, err := util.GetRestyClientWithCustomHeaders()
if err != nil {
Expand Down Expand Up @@ -629,7 +690,16 @@ func listDynamicSecretLeaseByName(cmd *cobra.Command, args []string) {
util.HandleError(err, "To fetch dynamic secret leases list")
}

visualize.PrintAllDynamicSecretLeases(dynamicSecretLeases)
if outputFormat != "" {
output, err := util.FormatOutput(outputFormat, dynamicSecretLeases, nil)
if err != nil {
util.HandleError(err, "Unable to format output")
}
fmt.Print(output)
} else {
visualize.PrintAllDynamicSecretLeases(dynamicSecretLeases)
}

Telemetry.CaptureEvent("cli-command:dynamic-secrets lease list", posthog.NewProperties().Set("lease-count", len(dynamicSecretLeases)).Set("version", util.CLI_VERSION))
}

Expand All @@ -641,6 +711,9 @@ func init() {
dynamicSecretLeaseCreateCmd.Flags().String("ttl", "", "The lease lifetime TTL. If not provided the default TTL of dynamic secret will be used.")
dynamicSecretLeaseCreateCmd.Flags().Bool("plain", false, "Print leased credentials without formatting, one per line")

// Add output flags
util.AddOutputFlagsToCmd(dynamicSecretLeaseCreateCmd, "The output to format the leased credentials in.")

// Kubernetes specific flags
dynamicSecretLeaseCreateCmd.Flags().String("kubernetes-namespace", "", "The namespace to create the lease in. Only used for Kubernetes dynamic secrets.")

Expand All @@ -650,19 +723,22 @@ func init() {
dynamicSecretLeaseListCmd.Flags().String("token", "", "Fetch dynamic secret leases machine identity access token")
dynamicSecretLeaseListCmd.Flags().String("projectId", "", "Manually set the projectId to fetch leased from when using machine identity based auth")
dynamicSecretLeaseListCmd.Flags().String("project-slug", "", "Manually set the project-slug to list leases from")
util.AddOutputFlagsToCmd(dynamicSecretLeaseListCmd, "The output to format the dynamic secret leases in.")
dynamicSecretLeaseCmd.AddCommand(dynamicSecretLeaseListCmd)

dynamicSecretLeaseRenewCmd.Flags().StringP("path", "p", "/", "The path from where dynamic secret should be leased from")
dynamicSecretLeaseRenewCmd.Flags().String("token", "", "Renew dynamic secrets machine identity access token")
dynamicSecretLeaseRenewCmd.Flags().String("projectId", "", "Manually set the projectId to fetch leased from when using machine identity based auth")
dynamicSecretLeaseRenewCmd.Flags().String("project-slug", "", "Manually set the project-slug to renew lease in")
dynamicSecretLeaseRenewCmd.Flags().String("ttl", "", "The lease lifetime TTL. If not provided the default TTL of dynamic secret will be used.")
util.AddOutputFlagsToCmd(dynamicSecretLeaseRenewCmd, "The output to format the dynamic secret lease renewal in.")
dynamicSecretLeaseCmd.AddCommand(dynamicSecretLeaseRenewCmd)

dynamicSecretLeaseRevokeCmd.Flags().StringP("path", "p", "/", "The path from where dynamic secret should be leased from")
dynamicSecretLeaseRevokeCmd.Flags().String("token", "", "Delete dynamic secrets using machine identity access token")
dynamicSecretLeaseRevokeCmd.Flags().String("projectId", "", "Manually set the projectId to fetch leased from when using machine identity based auth")
dynamicSecretLeaseRevokeCmd.Flags().String("project-slug", "", "Manually set the project-slug to revoke lease from")
util.AddOutputFlagsToCmd(dynamicSecretLeaseRevokeCmd, "The output to format the dynamic secret lease revocation in.")
dynamicSecretLeaseCmd.AddCommand(dynamicSecretLeaseRevokeCmd)

dynamicSecretCmd.AddCommand(dynamicSecretLeaseCmd)
Expand All @@ -672,5 +748,6 @@ func init() {
dynamicSecretCmd.Flags().String("project-slug", "", "Manually set the project-slug to fetch dynamic-secret from")
dynamicSecretCmd.PersistentFlags().String("env", "dev", "Used to select the environment name on which actions should be taken on")
dynamicSecretCmd.Flags().String("path", "/", "get dynamic secret within a folder path")
util.AddOutputFlagsToCmd(dynamicSecretCmd, "The output to format the dynamic secrets in.")
rootCmd.AddCommand(dynamicSecretCmd)
}
72 changes: 68 additions & 4 deletions packages/cmd/folder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ var getCmd = &cobra.Command{
if err != nil {
util.HandleError(err, "Unable to parse flag")
}
outputFormat, err := cmd.Flags().GetString("output")
if err != nil {
util.HandleError(err, "Unable to parse flag")
}

request := models.GetAllFoldersParameters{
Environment: environmentName,
Expand All @@ -64,7 +68,27 @@ var getCmd = &cobra.Command{
util.HandleError(err, "Unable to get folders")
}

visualize.PrintAllFoldersDetails(folders, foldersPath)
if outputFormat != "" {

var outputStructure []map[string]any
for _, folder := range folders {
outputStructure = append(outputStructure, map[string]any{
"folderName": folder.Name,
"folderPath": foldersPath,
"folderId": folder.ID,
})
}

output, err := util.FormatOutput(outputFormat, outputStructure, nil)

if err != nil {
util.HandleError(err, "Unable to format output")
}

fmt.Print(output)
} else {
visualize.PrintAllFoldersDetails(folders, foldersPath)
}
Telemetry.CaptureEvent("cli-command:folders get", posthog.NewProperties().Set("folderCount", len(folders)).Set("version", util.CLI_VERSION))
},
}
Expand Down Expand Up @@ -101,6 +125,11 @@ var createCmd = &cobra.Command{
util.HandleError(err, "Unable to parse name flag")
}

outputFormat, err := cmd.Flags().GetString("output")
if err != nil {
util.HandleError(err, "Unable to parse flag")
}

if folderName == "" {
util.HandleError(errors.New("invalid folder name, folder name cannot be empty"))
}
Expand Down Expand Up @@ -129,12 +158,28 @@ var createCmd = &cobra.Command{
params.InfisicalToken = token.Token
}

_, err = util.CreateFolder(params)
folder, err := util.CreateFolder(params)
if err != nil {
util.HandleError(err, "Unable to create folder")
}

util.PrintSuccessMessage(fmt.Sprintf("folder named `%s` created in path %s", folderName, folderPath))
if outputFormat != "" {

var outputStructure []map[string]any
outputStructure = append(outputStructure, map[string]any{
"folderName": folder.Name,
"folderPath": folderPath,
"folderId": folder.ID,
})

output, err := util.FormatOutput(outputFormat, outputStructure, nil)
if err != nil {
util.HandleError(err, "Unable to format output")
}
fmt.Print(output)
} else {
util.PrintSuccessMessage(fmt.Sprintf("folder named `%s` created in path %s", folderName, folderPath))
}

Telemetry.CaptureEvent("cli-command:folders create", posthog.NewProperties().Set("version", util.CLI_VERSION))
},
Expand Down Expand Up @@ -173,6 +218,11 @@ var deleteCmd = &cobra.Command{
util.HandleError(err, "Unable to parse name flag")
}

outputFormat, err := cmd.Flags().GetString("output")
if err != nil {
util.HandleError(err, "Unable to parse flag")
}

if folderName == "" {
util.HandleError(errors.New("invalid folder name, folder name cannot be empty"))
}
Expand Down Expand Up @@ -202,7 +252,21 @@ var deleteCmd = &cobra.Command{
util.HandleError(err, "Unable to delete folder")
}

util.PrintSuccessMessage(fmt.Sprintf("folder named `%s` deleted in path %s", folderName, folderPath))
if outputFormat != "" {
outputStructure := map[string]any{
"folderName": folderName,
"folderPath": folderPath,
}

output, err := util.FormatOutput(outputFormat, outputStructure, nil)
if err != nil {
util.HandleError(err, "Unable to format output")
}
fmt.Print(output)
} else {

util.PrintSuccessMessage(fmt.Sprintf("folder named `%s` deleted in path %s", folderName, folderPath))
}

Telemetry.CaptureEvent("cli-command:folders delete", posthog.NewProperties().Set("version", util.CLI_VERSION))
},
Expand Down
Loading