{"id":28267703,"url":"https://github.com/taubyte/dream","last_synced_at":"2026-03-07T09:01:57.181Z","repository":{"id":184963953,"uuid":"667582402","full_name":"taubyte/dream","owner":"taubyte","description":"A local cloud for rapid development and testing.","archived":false,"fork":false,"pushed_at":"2024-12-13T03:29:17.000Z","size":713,"stargazers_count":76,"open_issues_count":9,"forks_count":25,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-20T15:11:35.391Z","etag":null,"topics":["cloud-computing","cloud-native","devtools","edge-computing","go","localdevelopment","serverless","tau"],"latest_commit_sha":null,"homepage":"https://taubyte.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taubyte.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2023-07-17T20:57:35.000Z","updated_at":"2025-05-14T14:40:59.000Z","dependencies_parsed_at":"2024-01-17T00:04:53.717Z","dependency_job_id":"d059e826-dfb3-45cf-8fb3-803b6cb3e9d8","html_url":"https://github.com/taubyte/dream","commit_stats":null,"previous_names":["taubyte/dreamland","taubyte/dream"],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/taubyte/dream","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taubyte%2Fdream","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taubyte%2Fdream/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taubyte%2Fdream/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taubyte%2Fdream/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taubyte","download_url":"https://codeload.github.com/taubyte/dream/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taubyte%2Fdream/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260742348,"owners_count":23055745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cloud-computing","cloud-native","devtools","edge-computing","go","localdevelopment","serverless","tau"],"created_at":"2025-05-20T15:11:21.171Z","updated_at":"2026-03-07T09:01:57.157Z","avatar_url":"https://github.com/taubyte.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cdiv align=\"center\"\u003e\n\n[![Release](https://img.shields.io/github/release/taubyte/dream.svg)](https://github.com/taubyte/dream/releases)\n[![License](https://img.shields.io/github/license/taubyte/dream)](LICENSE)\n\u003c/div\u003e\n\n\u003cimg width=\"2664\" height=\"1364\" alt=\"dream cli diagram\" src=\"https://github.com/user-attachments/assets/4fd29715-9ca5-4d0c-a8d2-7c282978d353\" /\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\nDream is a CLI tool that forms part of Taubyte's suite of development tools, designed to create local cloud environments.\n\n## Installation\n\n## npm\nRun:\n\n```bash\n$ npm i @taubyte/dream\n```\n\n## Script\nRun:\n\n```bash\n$ curl https://get.tau.link/dream | sh\n```\n\n## Source\nSource is located in [https://github.com/taubyte/tau](https://github.com/taubyte/tau) under `tools/dream`.\n\n## Usage\n\nDream can simulate multiple Taubyte networks, each referred to as a 'universe'. You can start a new universe (default name is \"blackhole\") with the following command:\n\n```bash\n$ dream new multiverse \n```\nOnce the message `[SUCCESS] Universe blackhole started!` appears, your local Taubyte instance is ready. You are now running elder, monkey, tns, hoarder, patrick, auth, seer, and substrate nodes locally on your machine.\n\nYou can interact with Dream using the Web Console. Dream can be selected from the network selection dropdown if it's active locally. From here, you can create new projects, import existing ones, trigger builds, and run resources like websites and dFuncs.\n\n\n## Connecting Console to Dream\nSimilarly to when selecting a network on web console ([console.taubyte.com](https://console.taubyte.com)), dream can be selected from the network selection dropdown \nIf dream is active, then a selection option for dream will appear in the network selection\n![](images/web-console-login.png)\n\n\n### Import a project\nIf your intention is to create a new project, follow the steps that you normally would if you were connected to a production cloud, by clicking `Create Project`. Note that this will create a new GitHub repo, so it is recommended that you create this as a private repo.\n\nHowever, if you want to work on an existing project click on `Import Project`. This will show a menu with two dropdowns, one for your config repository, the other for your inline code repository. \n \u003e One convenient feature is that once selecting a config repository, if a code repository is found matching the config, it will be selected automatically.\n\n## Branches \nIf importing a project, it is recommended that you make changes to your project on a branch, rather than master/main to not affect production deployments. \n\u003e If using Web Console Once selecting a project, you may checkout or create a new branch from the top bar.\n\u003e ![](images/web-console-branch-selector.png)\n\n\nBy default, ci/cd events are triggered by events on the master/main branch. You will need to override this using a fixture `setBranch`:\n\n```bash\n$ dream inject set-branch {name-of-branch}\n```\n\n## Websites and Libraries\n\nIf importing a project that has a library, or website you will need to register the resource on auth, before being able to trigger a build for these resources. This can be achieved on web console by going to the resource and using the fix repo tool.\n\n![](images/web-console-fix-repo.png)\n\n\n## Running HTTP Resources\n\nHTTP resources run locally on Dream. You need to add the domains for these resources to your `/etc/hosts` file under `127.0.0.1`. To access these resources, you also need the port that the substrate node is running on. Once you have the domain and the port, you can access the resource at `{domain}:{port}/{path}`.\n\n## Viewing Port Information\n\nYou can view the ports that your local Tau protocols are running on using the status command.\n\nTo view a specific protocol's port (e.g., seer, auth, patrick, tns, hoarder, substrate):\n\n```bash\n$ dream status {protocol-name}\n```\n\nExample:\n```bash\n$ dream status substrate\n\n@ http://127.0.0.1:11429\n\n┌─────────────────────┬────────┬───────┐\n│ substrate@blackhole │ http   │ 11429 │\n│                     ├────────┼───────┤\n│                     │ p2p    │ 11182 │\n│                     ├────────┼───────┤\n│                     │ copies │     1 │\n│                     ├────────┼───────┤\n│                     │ dns    │ 11204 │\n└─────────────────────┴────────┴───────┘\n```\n\nTo view all ports:\n```bash\n$ dream status universe \n```\n\nOutput will look like:\n```bash\n┌───────┬─────────────────────┬────────┬───────┐\n│ Nodes │ elder@blackhole     │ p2p    │ 10951 │\n│       ├─────────────────────┼────────┼───────┤\n│       │ hoarder@blackhole   │ http   │ 10900 │\n│       │                     ├────────┼───────┤\n│       │                     │ p2p    │ 11042 │\n│       │                     ├────────┼───────┤\n│       │                     │ copies │     1 │\n│       │                     ├────────┼───────┤\n│       │                     │ dns    │ 11204 │\n│       ├─────────────────────┼────────┼───────┤\n│       │ monkey@blackhole    │ p2p    │ 11063 │\n│       │                     ├────────┼───────┤\n│       │                     │ copies │     1 │\n│       │                     ├────────┼───────┤\n│       │                     │ dns    │ 11204 │\n│       │                     ├────────┼───────┤\n│       │                     │ http   │ 10900 │\n│       ├─────────────────────┼────────┼───────┤\n│       │ tns@blackhole       │ copies │     1 │\n│       │                     ├────────┼───────┤\n│       │                     │ dns    │ 11204 │\n│       │                     ├────────┼───────┤\n│       │                     │ http   │ 11366 │\n│       │                     ├────────┼───────┤\n│       │                     │ p2p    │ 11126 │\n│       ├─────────────────────┼────────┼───────┤\n│       │ patrick@blackhole   │ copies │     1 │\n│       │                     ├────────┼───────┤\n│       │                     │ dns    │ 11204 │\n│       │                     ├────────┼───────┤\n│       │                     │ http   │ 11324 │\n│       │                     ├────────┼───────┤\n│       │                     │ p2p    │ 11084 │\n│       ├─────────────────────┼────────┼───────┤\n│       │ auth@blackhole      │ p2p    │ 11021 │\n│       │                     ├────────┼───────┤\n│       │                     │ copies │     1 │\n│       │                     ├────────┼───────┤\n│       │                     │ dns    │ 11204 │\n│       │                     ├────────┼───────┤\n│       │                     │ http   │ 11345 │\n│       ├─────────────────────┼────────┼───────┤\n│       │ seer@blackhole      │ http   │ 11303 │\n│       │                     ├────────┼───────┤\n│       │                     │ p2p    │ 11105 │\n│       │                     ├────────┼───────┤\n│       │                     │ copies │     1 │\n│       │                     ├────────┼───────┤\n│       │                     │ dns    │ 11204 │\n│       ├─────────────────────┼────────┼───────┤\n│       │ client@blackhole    │ p2p    │ 10952 │\n│       ├─────────────────────┼────────┼───────┤\n│       │ substrate@blackhole │ dns    │ 11204 │\n│       │                     ├────────┼───────┤\n│       │                     │ http   │ 11429 │\n│       │                     ├────────┼───────┤\n│       │                     │ p2p    │ 11182 │\n│       │                     ├────────┼───────┤\n│       │                     │ copies │     1 │\n└───────┴─────────────────────┴────────┴───────┘\n```\n\n\n## Running Fixtures\n\nFixtures are used to inject event \u0026 data into a universe. The main fixtures you might need are `pushAll` and `attachPlugin`.\n\n`push-all` fixture:\n\n```bash \n$ dream inject push-all\n```\n\n`attach-plugin` fixture:\n\n```bash\n$ dream inject attach-plugin -p {path-to-plugin}\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaubyte%2Fdream","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaubyte%2Fdream","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaubyte%2Fdream/lists"}