credctl setup aws-profile

Synopsis

credctl setup aws-profile [flags]

Description

credctl setup aws-profile adds a credential_process entry to ~/.aws/config so the AWS CLI and SDKs use credctl to obtain temporary credentials automatically.

The command creates or updates the specified profile with the credential_process directive pointing to the credctl binary, and sets the region from your credctl configuration.

Respects the AWS_CONFIG_FILE environment variable for custom config file locations. Preserves existing profiles and their settings.

Requires AWS to be configured first (credctl setup aws).

Flags

Flag	Type	Default	Description
`--profile`	string	`credctl`	AWS CLI profile name to create.
`--force`	bool	`false`	Overwrite the profile if it already exists.

Examples

Default profile name

credctl setup aws-profile

Configured profile 'credctl' in /Users/you/.aws/config
  AWS_PROFILE=credctl aws sts get-caller-identity

Use it:

AWS_PROFILE=credctl aws s3 ls

Set as default profile

credctl setup aws-profile --profile default

Configured profile 'default' in /Users/you/.aws/config
  aws sts get-caller-identity

Custom profile name

credctl setup aws-profile --profile myproject

Overwrite existing profile

credctl setup aws-profile --profile credctl --force

What it writes

The command adds a section like this to ~/.aws/config:

[profile credctl]
credential_process = /usr/local/bin/credctl auth
region = us-east-1

Exit codes

Code	Meaning
0	Profile configured successfully
1	Error (device not initialised, AWS not configured, profile already exists, or other error)