ggshield honeytoken plant
Description
Detect endpoint intrusion by planting a honeytoken on this machine.
ggshield honeytoken plant [OPTIONS]
Honeytokens deployed are fully synchronized with the GitGuardian platform.
Apply the desired on-disk state: write/refresh the decoy for write entries
(an AWS credentials profile under ~/.aws/, or a kubeconfig context under
~/.kube/), remove it for delete (revoked) entries — preserving any other
profiles/contexts the user already has. ggshield never revokes a honeytoken;
it only reports placement status.
Authorize with the honeytokens:write scope.
Options
-
--type TEXT: Honeytoken type to create for this machine (aws, kubeconfig). Existing deployments of every type are synchronized regardless.Default:
aws. -
--method [aws_credentials|aws_config_profile|kubeconfig]: Placement method for a new deployment (defaults to the type's method). -
--filename TEXT: Override the on-disk basename for a new deployment (safe charset only). -
--profile-name TEXT: Override the AWS profile/section name for a new deployment (AWS methods only). -
--user TEXT: Target OS user (defaults to the current user; as root, narrows the fan-out). -
--user-dir PATH: Override the resolved home directory (single-user; testing). -
--force: Overwrite the honeytoken entry (AWS profile or kubeconfig context) if it exists and is not ours. Never touches a cluster/user a real context still uses. -
--list-targets: Print the resolved planting targets and exit (no API call, no disk writes). -
--remove-only: Cleanup-only: read current state (read-only) and apply onlydeleteactions.
This command supports all ggshield global options.