Working with Images

Image URLs

All images are served via CDN with this URL structure:

https://cdn.banatie.app/{org}/{project}/img/{imageId}

URLs are permanent, fast, and cached globally. Use them directly in your applications.

Uploading Images

Upload your own images for use as brand assets, references, or logos (single file, ≤ 5 MB):

npx @banatie/cli image upload ./your-image.png --alias @brand-logo

Response includes the CDN URL and image details:

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "storageUrl": "https://cdn.banatie.app/my-org/my-project/img/550e8400-e29b-41d4-a716-446655440000",
    "alias": "@brand-logo",
    "source": "uploaded",
    "width": 512,
    "height": 512,
    "mimeType": "image/png",
    "fileSize": 24576
  }
}

Listing & Getting Images

List all images in your project:

npx @banatie/cli image list

Get a specific image by ID or alias (downloads it to your output directory):

# By UUID
npx @banatie/cli image get 550e8400-e29b-41d4-a716-446655440000 --output-dir .

# By alias
npx @banatie/cli image get @brand-logo --output-dir .

Aliases

Assign memorable names to images. Aliases start with @ and make it easy to reference images without remembering UUIDs.

npx @banatie/cli image alias 550e8400-e29b-41d4-a716-446655440000 @hero-background

Access images via CDN using their alias:

https://cdn.banatie.app/my-org/my-project/img/@hero-background

Remove an alias with --remove:

npx @banatie/cli image alias 550e8400-e29b-41d4-a716-446655440000 --remove

Deleting Images

Delete an image by ID or alias. This permanently removes the image from storage.

npx @banatie/cli image delete 550e8400-e29b-41d4-a716-446655440000

Next Steps