-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
64 lines (62 loc) · 2.36 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package safecli
// Copyright 2024 The Kanister Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package safecli provides functionality for building, redacting, and logging command-line arguments.
// It is designed to handle sensitive values securely
// while also providing utility for CLI construction and logging.
//
// The package offers two concrete builder functions:
// - NewBuilder: Creates a new CLI builder, allowing for flexible CLI creation.
// - NewLogger: Creates a new CLI logger for safely CLI logging.
//
// Usage example:
//
// package main
//
// import (
// "fmt"
// "github.com/kanisterio/safecli"
// )
//
// func main() {
// // Create a new command builder
// zipcli := safecli.NewBuilder("zip").
// AppendLoggableKV(
// "--temp-path", "/tmp",
// "--exclude", "*.log",
// ).
// AppendRedactedKV("-p", "password123").
// AppendLoggable(
// "project_backup.zip",
// "~/home/user/project")
//
// fmt.Println("Builder:", zipcli)
// // Output: Builder: [zip --temp-path=/tmp --exclude=*.log -p=<****> project_backup.zip ~/home/user/project]
// // The fmt.Println call implicitly invokes the String() method on zipcli,
// // which returns a log string representation of the command.
// // This is similar to calling logger.Log() as shown below.
//
// // Build the command.
// command := zipcli.Build()
// fmt.Println("Command:", command)
// // Output: Command: [zip --temp-path=/tmp --exclude=*.log -p=password123 project_backup.zip ~/home/user/project]
//
// // Log the command with sensitive data redacted.
// logger := safecli.NewLogger(zipcli)
// logOutput := logger.Log()
//
// fmt.Println("Log:", logOutput)
// // Output: Log: zip --temp-path=/tmp --exclude=*.log -p=<****> project_backup.zip ~/home/user/project
// }
//