Skip to main content

Quickstart - AWS CLI

If you have the AWS CLI installed, you can start using Fil One in under 2 minutes.

1. Install the AWS CLI​

Use AWS CLI v2 — v1 does not read endpoint_url from config files:

brew install awscli
# or follow the official installer:
# https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html

2. Configure credentials​

Set up a named profile so you don't have to pass --endpoint-url on every command:

# ~/.aws/config
[profile filone]
endpoint_url = https://eu-west-1.s3.filonecontent.com
region = eu-west-1
s3 =
    addressing_style = path

The addressing_style = path line is required — Fil One only supports path-style URLs, and the CLI otherwise defaults to virtual-hosted style, which fails.

The endpoint depends on your bucket's region

The example above uses eu-west-1, the default region. If your bucket is in us-east-1, use https://us-east-1.s3.filonecontent.com and region = us-east-1 instead. The endpoint and the region must both match the bucket you are working with, and your access key has to belong to that region too.

If you use both regions, set up a profile per region ([profile filone-eu], [profile filone-us]) and pick with --profile.

# ~/.aws/credentials
[filone]
aws_access_key_id = YOUR_ACCESS_KEY
aws_secret_access_key = YOUR_SECRET_KEY

3. Create a bucket​

Whether CreateBucket works through the S3 API depends on the region. It is not available in eu-west-1, the default region — there, create buckets from the Fil One dashboard by going to Buckets → Create bucket, entering a name, and clicking Create bucket.

In us-east-1 you can create a bucket from the CLI, using a key that has the CreateBucket permission. This requires a us-east-1 profile — define one the same way as the filone profile above but with the us-east-1 endpoint and region (shown here as filone-us):

aws s3 mb s3://my-bucket --profile filone-us

Creating from the dashboard is worth doing regardless, since that is where you set versioning and Object Lock — both are fixed at creation. See Buckets.

Once the bucket exists, use the AWS CLI for all object operations.

4. Upload a file​

aws s3 cp my-file.txt s3://my-first-bucket/ --profile filone

5. List objects​

aws s3 ls s3://my-first-bucket/ --profile filone

6. Download the file​

aws s3 cp s3://my-first-bucket/my-file.txt ./downloaded.txt --profile filone