Documentation / Usage

From your first test
to your application.

Connect your tools, create a local resource and check the workflow your project needs.

Connect AWS CLI once

In that second terminal, save local test credentials, the region, and the endpoint in a named AWS CLI v2 profile:

Terminal
aws configure set aws_access_key_id test --profile locallycloud
aws configure set aws_secret_access_key test --profile locallycloud
aws configure set region us-east-1 --profile locallycloud
aws configure set endpoint_url http://127.0.0.1:4566 --profile locallycloud
aws --profile locallycloud sts get-caller-identity

Your first file in S3

Using the profile configured above:

Terminal
printf 'hello\n' > /tmp/locallycloud-demo.txt
aws --profile locallycloud s3api create-bucket \
  --bucket locallycloud-demo
aws --profile locallycloud s3api put-object \
  --bucket locallycloud-demo --key greeting.txt --body /tmp/locallycloud-demo.txt
aws --profile locallycloud s3api get-object \
  --bucket locallycloud-demo --key greeting.txt /tmp/locallycloud-download.txt
cat /tmp/locallycloud-download.txt

The downloaded file should contain hello.

These are local test credentials. Use a dedicated terminal and check existing AWS endpoint and credential overrides.

Profile configuration ↗

Check your running environment

Terminal
curl -fsS http://127.0.0.1:4566/_locallycloud/status

Registration does not imply full AWS coverage. Keep the same master key when restarting with existing state.

For SDKs, Terraform, AWS SAM, Serverless Framework v3 and osls v4, follow the tested workflows in the repository.

Tools and compatibility ↗