diff --git a/cmd/soci/commands/rebuild_db.go b/cmd/soci/commands/rebuild_db.go index 21e9586cc..b56d979f3 100644 --- a/cmd/soci/commands/rebuild_db.go +++ b/cmd/soci/commands/rebuild_db.go @@ -27,7 +27,13 @@ import ( var RebuildDBCommand = cli.Command{ Name: "rebuild-db", - Usage: `rebuild the artifacts database. You should use this command after "rpull" so that indices/ztocs can be discovered by commands like "soci index list", and after "index rm" when using the containerd content store so that deleted orphaned zTOCs will be forgotten`, + Usage: "rebuilds the artifacts database", + UsageText: ` + soci [global options] rebuild-db + + Use after pulling an image to discover SOCI indices/ztocs or after "index rm" + when using the containerd content store to clear the database of removed zTOCs. + `, Action: func(cliContext *cli.Context) error { client, ctx, cancel, err := internal.NewClient(cliContext) if err != nil { diff --git a/docs/cli-usage.md b/docs/cli-usage.md index f4bf3fd42..d2a3be9a3 100644 --- a/docs/cli-usage.md +++ b/docs/cli-usage.md @@ -61,7 +61,8 @@ soci push public.ecr.aws/soci-workshop-examples/ffmpeg:latest ``` ### soci rebuild_db -Use this command after image pull so that indices/ztocs can be discovered by commands like "```soci index list```", and after "```index rm```" when using the containerd content store so that deleted orphaned zTOCs will be forgotten +Use after pulling an image to discover SOCI indices/ztocs or after "```index rm```" +when using the containerd content store to clear the database of removed zTOCs. **Example:** ```