Skip to content

Commit dadbfcf

Browse files
committed
README: fix the flag commands and update readme
Signed-off-by: Morten Linderud <[email protected]>
1 parent b969902 commit dadbfcf

File tree

2 files changed

+27
-17
lines changed

2 files changed

+27
-17
lines changed

README.md

+25-15
Original file line numberDiff line numberDiff line change
@@ -103,23 +103,33 @@ Usage:
103103
sbctl [command]
104104
105105
Available Commands:
106-
bundle Bundle the needed files for an EFI stub image
107-
create-keys Create a set of secure boot signing keys
108-
enroll-keys Enroll the current keys to EFI
109-
generate-bundles Generate all EFI stub bundles
110-
help Help about any command
111-
list-bundles List stored bundles
112-
list-files List enrolled files
113-
remove-bundle Remove bundle from database
114-
remove-file Remove file from database
115-
sign Sign a file with secure boot keys
116-
sign-all Sign all enrolled files with secure boot keys
117-
status Show current boot status
118-
verify Find and check if files in the ESP are signed or not
106+
bundle Bundle the needed files for an EFI stub image
107+
create-keys Create a set of secure boot signing keys
108+
enroll-keys Enroll the current keys to EFI
109+
export-enrolled-keys Export already enrolled keys from the system
110+
generate-bundles Generate all EFI stub bundles
111+
help Help about any command
112+
import-keys Import keys into sbctl
113+
list-bundles List stored bundles
114+
list-enrolled-keys List enrolled keys on the system
115+
list-files List enrolled files
116+
remove-bundle Remove bundle from database
117+
remove-file Remove file from database
118+
reset Reset Secure Boot Keys
119+
rotate-keys Rotate secure boot keys with new keys.
120+
setup Setup sbctl
121+
sign Sign a file with secure boot keys
122+
sign-all Sign all enrolled files with secure boot keys
123+
status Show current boot status
124+
verify Find and check if files in the ESP are signed or not
119125
120126
Flags:
121-
-h, --help help for sbctl
122-
--json Output as json
127+
--config string Path to configuration file
128+
--debug debug logging
129+
--disable-landlock disable landlock
130+
-h, --help help for sbctl
131+
--json Output as json
132+
--quiet Mute info from logging
123133
124134
Use "sbctl [command] --help" for more information about a command.
125135
```

cmd/sbctl/main.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ func baseFlags(cmd *cobra.Command) {
6060
flags := cmd.PersistentFlags()
6161
flags.BoolVar(&cmdOptions.JsonOutput, "json", false, "Output as json")
6262
flags.BoolVar(&cmdOptions.QuietOutput, "quiet", false, "Mute info from logging")
63-
flags.BoolVar(&cmdOptions.DisableLandlock, "disable-landlock", false, "disable landlock")
64-
flags.BoolVar(&cmdOptions.Debug, "debug", false, "debug logging")
63+
flags.BoolVar(&cmdOptions.DisableLandlock, "disable-landlock", false, "Disable landlock sandboxing")
64+
flags.BoolVar(&cmdOptions.Debug, "debug", false, "Enable verbose debug logging")
6565
flags.StringVarP(&cmdOptions.Config, "config", "", "", "Path to configuration file")
6666

6767
cmd.PersistentPreRun = func(cmd *cobra.Command, args []string) {

0 commit comments

Comments
 (0)