Elixir client for the Incus REST API.

Quick start

# Local Unix socket (default: /var/lib/incus/unix.socket)
client = ExIncus.connect()

# Or a remote server with TLS client certificate auth
client =
  ExIncus.connect(
    base_url: "https://incus.example.net:8443",
    certfile: "client.crt",
    keyfile: "client.key"
  )

# Create + start a container from images.linuxcontainers.org
{:ok, _} = ExIncus.launch(client, "web1", "debian/12")

{:ok, result} = ExIncus.exec(client, "web1", ["hostname"])

{:ok, _} =
  ExIncus.push_file(client, "web1", "/etc/resolv.conf",
    "nameserver 10.140.100.1\n", mode: 0o644)

{:ok, _} = ExIncus.stop(client, "web1")
{:ok, _} = ExIncus.delete_instance(client, "web1")

This module only hosts shortcuts for the most common instance operations; the full API surface lives in the resource modules:

• ExIncus.Instances - lifecycle, state, config/devices, exec, files
• ExIncus.EventListener - live event stream (websocket), for dashboards
• ExIncus.Snapshots - instance snapshots
• ExIncus.Networks - networks and DHCP leases
• ExIncus.Profiles - profiles
• ExIncus.Images - images and aliases
• ExIncus.Projects - projects
• ExIncus.StoragePools / ExIncus.StorageVolumes - storage
• ExIncus.Certificates - trust store
• ExIncus.Server - server info and configuration
• ExIncus.Operations - background operations
• ExIncus.Client - connection handling and raw requests

Conventions

Every call takes the client first and returns {:ok, result} or {:error, %ExIncus.Error{}}. State-changing calls are waited on by default; pass wait: false for fire-and-forget (you get the ExIncus.Operation back) or timeout: seconds | :infinity to control the wait. Endpoints not wrapped yet are reachable via ExIncus.Client.request/4.