Getting started

This document is a guide for getting started with evroc Object Storage. In this guide you'll create a bucket, upload some data to it, download the data, and then clean up the data and the bucket.

Prerequisites

This guide requires you to have the evroc CLI downloaded and for the CLI to be logged in to your evroc organisation. For instructions on this, see the getting started page.

The first step to use evroc Object Storage is to create a bucket, which is a named top-level container for storing your data. Each bucket has a unique name (unique inside the project) which is used to identify it and its content. For this guide we'll use the name my-bucket.

To create a bucket, use the storage bucket create command with the evroc CLI:

evroc storage bucket create my-bucket

If successful the evroc CLI responds with a message that the creation of your bucket has been requested. Your terminal output looks like this:

evroc storage bucket create my-bucket
# created

To verify that the bucket has been successfully created and is ready, use the storage bucket get command with the evroc CLI:

evroc storage bucket get my-bucket

The output in your terminal looks similar to this example:

evroc storage bucket get my-bucket

kind: Bucket
apiVersion: storage/v1
metadata:
    id: my-bucket
    uid: 32fa20c9-0216-41a0-8083-5ea6d8763c48
    userLabels: {}
    systemLabels: {}
    creationTimestamp: "2026-01-29T14:06:23Z"
    generation: 2
    project: my-project
    region: se-sto
    resourceVersion: "7556185"
spec: {}
status:
    conditions:
        - lastTransitionTime: "2026-01-29T14:06:23Z"
          message: Bucket created successfully
          observedGeneration: 2
          reason: Ready
          status: "True"
          type: Ready

Note how there's a condition of type Ready, with status True for this bucket. This means the creation of the bucket has completed and it's ready for use.

Upload a file to the bucket

Next we'll upload a file to the bucket. For the guide we'll create a small text file in the terminal named my-file.txt containing a small message:

echo "Hello, evroc Cloud" > my-file.txt

To upload a file from your local computer to the bucket, use the following storage bucket copy command with the evroc CLI:

evroc storage bucket copy --from my-file.txt --to bucket://my-bucket/my-file.txt

This command takes two arguments to specify the upload: --from to specify which file to upload, and --to to specify the target. In this specific command the arguments we specify are:

--from my-file.txt, referencing the local file my-file.txt that you recently created
--to bucket://my-bucket/my-file.txt, referencing an object called my-file.txt in the bucket called my-bucket. The bucket:// prefix in this argument specifies that this is a remote location, the lack of this prefix specifies a local location.

If successful your terminal output looks similar to this:

evroc storage bucket copy --from my-file.txt --to bucket://my-bucket/my-file.txt

{
    "destination": "my-file.txt",
    "operation": "cp",
    "source": "bucket://my-bucket/my-file.txt",
    "success": true
}

List the objects in the bucket

To see what objects are stored in a bucket, use the storage bucket list command with the evroc CLI:

evroc storage bucket list my-bucket

This command lists all the objects stored inside the specified bucket, in this case the bucket my-bucket.

Download an object

To download an object stored in your bucket you can again use the storage bucket copy command with the evroc CLI, but this time with the arguments switched:

evroc storage bucket copy --from bucket://my-bucket/my-file.txt --to my-file-from-evroc-cloud.txt

This command is similar to the one we earlier used to upload the file, except that this time the --from argument refers to the remote location and the --to argument refers to a local location.

Once downloaded you can verify that the file you just downloaded contains the correct data, with e.g. cat:

cat my-file-from-evroc-cloud.txt
# Hello, evroc Cloud

Delete an object

To delete objects whose data you no longer need to store, use the storage bucket delete command with the evroc CLI:

evroc storage bucket delete bucket://my-bucket/my-file.txt

Here we refer to a remote location with the bucket:// prefix, which means that we're targeting an object inside the bucket. If successful your terminal output looks similar to this:

evroc storage bucket delete s3://my-bucket/my-file.txt

Are you sure (y/n)?
y
deleted object "my-file.txt" from bucket "my-bucket"

Delete a bucket

To delete a bucket that you no longer need, use the storage bucket delete command with the evroc CLI:

Note: This action requires the bucket to be empty, which it should be if you've followed this guide correctly. For more information about this, see bucket deletion.

evroc storage bucket delete my-bucket

Note that this time there's no bucket:// prefix, which means that we're targeting the bucket itself instead of any objects inside it.

evroc User Documentation