{
"name": "bws",
"subcommands": [
{
"name": "config",
"description": "Specify server settings for the Secrets Manager CLI",
"options": [
{
"names": [
"--profile"
],
"description": "Save specified value(s) to an alternate profile",
"takes_arg": true,
"arg": {
"name": "profile",
"description": "Profile name to save to"
}
},
{
"names": [
"--config-file"
],
"description": "Save specified value(s) to an alternative config file",
"takes_arg": true,
"arg": {
"name": "Config file path",
"template": "filepaths"
}
},
{
"names": [
"-h",
"--help"
],
"description": "Display help for login command"
}
],
"args": [
{
"name": "Setting",
"description": "Server setting to specify",
"suggestions": [
"server-base",
"server-api",
"server-identity",
"state-file-dir"
]
}
]
},
{
"name": "completions",
"description": "Generate shell completions",
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Display help for logout command"
}
],
"args": [
{
"name": "SHELL",
"description": "Shell to generate completions for",
"suggestions": [
"bash",
"elvish",
"fish",
"powershell",
"zsh"
]
}
]
},
{
"name": "project",
"description": "Access, manipulate and create projects",
"subcommands": [
{
"name": "create",
"description": "Create a new project",
"args": [
{
"name": "NAME",
"description": "Name of project to be created"
}
]
},
{
"name": "delete",
"description": "Delete one or more existing projects",
"args": [
{
"name": "PROJECT_ID(s)",
"description": "ID(s) of project(s) to delete"
}
]
},
{
"name": "edit",
"description": "Change the name of an existing project",
"args": [
{
"name": "--name",
"description": "New project name"
},
{
"name": "PROJECT_ID",
"description": "ID of project to edit"
}
]
},
{
"name": "get",
"description": "Retrieve a specific project accessible to this service account",
"args": [
{
"name": "PROJECT_ID",
"description": "ID of project to retrieve"
}
]
},
{
"name": "list",
"description": "List projects accessible to this service account"
}
],
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Access, manipulate and create projects"
}
]
},
{
"name": "secret",
"description": "Access, manipulate and create secrets",
"subcommands": [
{
"name": "create",
"description": "Create a new secret",
"options": [
{
"names": [
"--note"
],
"description": "Optional notes about this secret"
}
],
"args": [
{
"name": "KEY",
"description": "Secret Key"
},
{
"name": "VALUE",
"description": "Secret Value"
},
{
"name": "PROJECT_ID",
"description": "The ID of the project this secret will be added to"
}
]
},
{
"name": "delete",
"description": "Delete an existing secret",
"args": [
{
"name": "SECRET_IDS",
"description": "Delete one or more secrets designated by SECRET_IDS"
}
]
},
{
"name": "edit",
"description": "Edit an existing secret",
"options": [
{
"names": [
"key"
],
"description": "Edit the Secret Key"
},
{
"names": [
"value"
],
"description": "Edit the Secret Value"
},
{
"names": [
"project-id"
],
"description": "Edit the ID of project this secret belongs to"
},
{
"names": [
"note"
],
"description": "Edit the optional notes about this secret"
}
],
"args": [
{
"name": "SECRET_ID",
"description": "ID of secret to be edited"
}
]
},
{
"name": "get",
"description": "Retrieve an existing secret",
"args": [
{
"name": "SECRET_ID",
"description": "Secret to retrieve"
}
]
},
{
"name": "list",
"description": "List the secrets this service account can access",
"args": [
{
"name": "Project",
"description": "Project Identifier"
}
]
}
],
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Display help for unlock command"
}
]
},
{
"name": "--help",
"aliases": [
"-h"
],
"description": "Get help about using the Bitwarden Secrets Manager CLI tool"
}
],
"options": [
{
"names": [
"-o",
"--output"
],
"description": "Output format [default: json]",
"takes_arg": true,
"arg": {
"name": "Format",
"description": "Select output format",
"suggestions": [
"json",
"yaml",
"env",
"table",
"tsv",
"none"
]
}
},
{
"names": [
"-c",
"--color"
],
"description": "Use colors in the output [default: auto]",
"takes_arg": true,
"arg": {
"name": "Color",
"description": "Select output coloration scheme",
"suggestions": [
"no",
"yes",
"auto"
]
}
},
{
"names": [
"-t",
"--access-token"
],
"description": "Specify access token for the service account [env: BWS_ACCESS_TOKEN]",
"takes_arg": true,
"arg": {
"name": "Access Token",
"description": "Bitwarden Secrets Manager Access Token"
}
},
{
"names": [
"-f",
"--config-file"
],
"description": "Config file to use [default: ~/.bws.config]",
"takes_arg": true,
"arg": {
"name": "Config File",
"template": "filepaths"
}
},
{
"names": [
"-p",
"--profile"
],
"description": "Profile to use from the config file [env: BWS_PROFILE=]",
"takes_arg": true,
"arg": {
"name": "Profile",
"description": "User Profile to enable"
}
},
{
"names": [
"-u",
"--server-url"
],
"description": "Override the server URL from the config file [env: BWS_SERVER_URL=]",
"takes_arg": true,
"arg": {
"name": "Server URL",
"description": "URL of Bitwarden Secrets Manager server"
}
},
{
"names": [
"-h",
"--help"
],
"description": "Print help"
},
{
"names": [
"-V",
"--version"
],
"description": "Print version"
}
]
}