ggshield honeytoken create-with-context
Description
Create a honeytoken within a context.
ggshield honeytoken create-with-context [OPTIONS]
The context is a realistic file in which your honeytoken is inserted. Adding your honeytoken within a relevant context makes it look more credible.
The prerequisites to use this command are the following:
you have the necessary permissions as a user (for now, Honeytoken is restricted to users with a "Manager" access level),
the personal access token used by ggshield has the
honeytokens:write
scope.
Options
--name TEXT
: Specify a name for your honeytoken. If this option is not provided, a unique name will be generated with aggshield-
prefix.--type [AWS]
: Specify the type of honeytoken that you want to create. (For now only AWS honeytokens are supported) [required]--description TEXT
: Add a description to your honeytoken (250 characters max).--language TEXT
: Language to use for the context. If not set, ggshield infers the language from the repository or from OUTPUT_FILE, if set.-o
,--output FILE
: Filename to store your honeytoken.
This command supports all ggshield global options.