{"id":47696457,"url":"https://github.com/pepicrft/terrarium","last_synced_at":"2026-04-02T16:27:23.483Z","repository":{"id":346750624,"uuid":"1191407573","full_name":"pepicrft/terrarium","owner":"pepicrft","description":"An Elixir abstraction for provisioning and interacting with sandbox environments","archived":false,"fork":false,"pushed_at":"2026-03-25T21:09:28.000Z","size":62,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-26T12:34:48.783Z","etag":null,"topics":["elixir","sandbox"],"latest_commit_sha":null,"homepage":"https://hex.pm/packages/terrarium","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pepicrft.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-03-25T08:01:45.000Z","updated_at":"2026-03-25T20:04:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/pepicrft/terrarium","commit_stats":null,"previous_names":["pepicrft/terrarium"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/pepicrft/terrarium","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepicrft%2Fterrarium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepicrft%2Fterrarium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepicrft%2Fterrarium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepicrft%2Fterrarium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pepicrft","download_url":"https://codeload.github.com/pepicrft/terrarium/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pepicrft%2Fterrarium/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31309881,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","sandbox"],"created_at":"2026-04-02T16:27:22.814Z","updated_at":"2026-04-02T16:27:23.463Z","avatar_url":"https://github.com/pepicrft.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Terrarium\n\n[![Hex.pm](https://img.shields.io/hexpm/v/terrarium.svg)](https://hex.pm/packages/terrarium)\n[![HexDocs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/terrarium)\n[![CI](https://github.com/pepicrft/terrarium/actions/workflows/terrarium.yml/badge.svg)](https://github.com/pepicrft/terrarium/actions/workflows/terrarium.yml)\n\nAn Elixir abstraction for provisioning and interacting with sandbox environments.\n\n## Motivation\n\nThe AI agent ecosystem is producing many sandbox environment providers - Daytona, E2B, Modal, Fly Sprites, Namespace, and more. Each has its own API, SDK, and conventions. Terrarium provides a common Elixir interface so your code doesn't couple to any single provider.\n\n## Features\n\n- **Provider behaviour** - a single contract for creating, destroying, and querying sandbox environments\n- **Process execution** - run commands in sandboxes with structured results\n- **File operations** - read, write, and list files within sandboxes\n- **Named providers** - configure multiple providers with their credentials, pick a default\n- **Local provider** - built-in provider for dev/test that runs everything on the local machine\n- **Serialization** - persist and restore sandbox references across client restarts\n- **Provider-agnostic** - swap providers without changing application code\n- **Replication** - replicate the current BEAM application (OTP version + code) into a sandbox and get a connected peer node\n\n## Installation\n\nAdd `terrarium` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:terrarium, \"~\u003e 0.2.0\"}\n  ]\nend\n```\n\n## Configuration\n\nConfigure multiple providers and set a default, similar to Finch pools:\n\n```elixir\n# config/runtime.exs\nconfig :terrarium,\n  default: :daytona,\n  providers: [\n    daytona: {Terrarium.Daytona, api_key: System.fetch_env!(\"DAYTONA_API_KEY\"), region: \"us\"},\n    e2b: {Terrarium.E2B, api_key: System.fetch_env!(\"E2B_API_KEY\")},\n    local: Terrarium.Providers.Local\n  ]\n```\n\nConnect to an existing machine via SSH:\n\n```elixir\nconfig :terrarium,\n  default: :server,\n  providers: [\n    server: {Terrarium.Providers.SSH,\n      host: \"dev.example.com\",\n      user: \"deploy\",\n      auth: {:key, System.fetch_env!(\"SSH_PRIVATE_KEY\")}\n    }\n  ]\n```\n\nFor development, use the built-in local provider:\n\n```elixir\n# config/dev.exs\nconfig :terrarium,\n  default: :local,\n  providers: [\n    local: Terrarium.Providers.Local\n  ]\n```\n\n## Quick Start\n\n### 1. Add a provider package\n\n```elixir\ndef deps do\n  [\n    {:terrarium, \"~\u003e 0.2.0\"},\n    {:terrarium_daytona, \"~\u003e 0.1.0\"}\n  ]\nend\n```\n\n### 2. Create and use a sandbox\n\n```elixir\n# Uses the configured default provider\n{:ok, sandbox} = Terrarium.create(image: \"debian:12\")\n\n# Or use a specific named provider\n{:ok, sandbox} = Terrarium.create(:e2b, image: \"debian:12\")\n\n# Or pass a provider module directly\n{:ok, sandbox} = Terrarium.create(Terrarium.Daytona, image: \"debian:12\", api_key: \"...\")\n\n# Execute commands\n{:ok, result} = Terrarium.exec(sandbox, \"echo hello\")\nIO.puts(result.stdout)\n\n# File operations\n:ok = Terrarium.write_file(sandbox, \"/app/hello.txt\", \"Hello from Terrarium!\")\n{:ok, content} = Terrarium.read_file(sandbox, \"/app/hello.txt\")\n\n# Clean up\n:ok = Terrarium.destroy(sandbox)\n```\n\n### 3. Surviving client restarts\n\nSandboxes can be serialized and restored if the client process restarts while the remote sandbox is still running:\n\n```elixir\n# Persist before shutdown\ndata = Terrarium.Sandbox.to_map(sandbox)\nMyStore.save(\"sandbox-123\", data)\n\n# Restore after restart\ndata = MyStore.load(\"sandbox-123\")\nsandbox = Terrarium.Sandbox.from_map(data)\n{:ok, sandbox} = Terrarium.reconnect(sandbox)\n```\n\n## Implementing a Provider\n\nProviders implement the `Terrarium.Provider` behaviour:\n\n```elixir\ndefmodule MyProvider do\n  use Terrarium.Provider\n\n  @impl true\n  def create(opts) do\n    # Provision a sandbox via your provider's API\n    {:ok, %Terrarium.Sandbox{id: id, provider: __MODULE__, state: %{...}}}\n  end\n\n  @impl true\n  def destroy(sandbox) do\n    # Tear down the sandbox\n    :ok\n  end\n\n  @impl true\n  def status(sandbox) do\n    :running\n  end\n\n  @impl true\n  def reconnect(sandbox) do\n    # Verify the sandbox is still alive, refresh tokens, etc.\n    {:ok, sandbox}\n  end\n\n  @impl true\n  def exec(sandbox, command, opts) do\n    # Execute the command\n    {:ok, %Terrarium.Process.Result{exit_code: 0, stdout: output}}\n  end\n\n  # File operations are optional - defaults return {:error, :not_supported}\n  @impl true\n  def read_file(sandbox, path) do\n    {:ok, content}\n  end\n\n  @impl true\n  def write_file(sandbox, path, content) do\n    :ok\n  end\nend\n```\n\n## Available Providers\n\n| Provider | Package | Status |\n|---|---|---|\n| Local | `terrarium` (built-in) | Available |\n| SSH | `terrarium` (built-in) | Available |\n| [Daytona](https://daytona.io) | `terrarium_daytona` | Planned |\n| [E2B](https://e2b.dev) | `terrarium_e2b` | Planned |\n| [Modal](https://modal.com) | `terrarium_modal` | Planned |\n| [Fly Sprites](https://sprites.dev) | `terrarium_sprites` | Planned |\n| [Namespace](https://namespace.so) | `terrarium_namespace` | Planned |\n\n## Replication\n\nReplicate the current BEAM application into a sandbox with a single call. `Terrarium.replicate/2` detects the local OTP version, installs a matching Erlang in the sandbox, deploys the running node's code, and starts a connected peer:\n\n```elixir\n{:ok, sandbox} = Terrarium.create(image: \"debian:12\")\n{:ok, pid, node} = Terrarium.replicate(sandbox)\n\n# Call your own modules on the remote node\n:erpc.call(node, MyModule, :my_function, [args])\n\n# Clean up\nTerrarium.stop_replica(pid)\nTerrarium.destroy(sandbox)\n```\n\nOptions: `:name`, `:env`, `:erl_args`, `:dest` (remote deploy path), `:timeout` (Erlang install timeout).\n\n## Telemetry\n\nTerrarium emits telemetry events for all operations via `:telemetry.span/3`. Each operation emits `:start`, `:stop`, and `:exception` events automatically.\n\n| Event | Metadata |\n|---|---|\n| `[:terrarium, :create, *]` | `%{provider: module}` |\n| `[:terrarium, :destroy, *]` | `%{sandbox: sandbox}` |\n| `[:terrarium, :exec, *]` | `%{sandbox: sandbox, command: string}` |\n| `[:terrarium, :read_file, *]` | `%{sandbox: sandbox, path: string}` |\n| `[:terrarium, :write_file, *]` | `%{sandbox: sandbox, path: string}` |\n| `[:terrarium, :ls, *]` | `%{sandbox: sandbox, path: string}` |\n| `[:terrarium, :reconnect, *]` | `%{sandbox: sandbox}` |\n| `[:terrarium, :status, *]` | `%{sandbox: sandbox}` |\n| `[:terrarium, :ssh_opts, *]` | `%{sandbox: sandbox}` |\n| `[:terrarium, :replicate, *]` | `%{sandbox: sandbox, otp_version: string}` |\n\n```elixir\n:telemetry.attach_many(\n  \"terrarium-logger\",\n  [\n    [:terrarium, :create, :stop],\n    [:terrarium, :exec, :stop],\n    [:terrarium, :destroy, :stop]\n  ],\n  fn event, measurements, metadata, _config -\u003e\n    Logger.info(\"#{inspect(event)} took #{measurements.duration} native time units\")\n  end,\n  nil\n)\n```\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpepicrft%2Fterrarium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpepicrft%2Fterrarium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpepicrft%2Fterrarium/lists"}