|
| 1 | +--- |
| 2 | +title: Run your first task |
| 3 | +icon: play |
| 4 | +description: Connect a model and repository, run a small task, and review the result in your browser. |
| 5 | +--- |
| 6 | + |
| 7 | +Follow this guide after you can open your Roomote deployment. The steps are |
| 8 | +the same for Roomote Cloud and self-hosted deployments, with hosting |
| 9 | +differences called out below. By the end, you will have a Roomote task that |
| 10 | +reads a repository, runs commands in a sandbox, and reports what it found. |
| 11 | + |
| 12 | +## Before you start |
| 13 | + |
| 14 | +Have these ready: |
| 15 | + |
| 16 | +- the deployment's initial setup link, or an administrator account if setup |
| 17 | + has already started |
| 18 | +- an inference provider account with usable credentials and available credit |
| 19 | + or quota, unless you choose the Roomote inference offered during Cloud setup |
| 20 | +- permission to connect one repository for the first task |
| 21 | + |
| 22 | +An inference provider supplies the model. A sandbox provider supplies the |
| 23 | +isolated workspace where the agent edits files and runs commands. Both are |
| 24 | +needed for the task in this guide. Cloud provisions a sandbox provider; |
| 25 | +for a self-hosted deployment, the installer can configure Docker on your host. |
| 26 | + |
| 27 | +<Note> |
| 28 | +You can start a conversation after connecting inference alone. Repository |
| 29 | +access and a sandbox are needed for this repository task. Slack, other |
| 30 | +communications providers, integrations, and automations are optional: you |
| 31 | +can complete the whole guide in your browser. |
| 32 | +</Note> |
| 33 | + |
| 34 | +## 1. Open your deployment and create your account |
| 35 | + |
| 36 | +Open the deployment link from the Cloud portal or your self-hosted installer. |
| 37 | +Follow the account setup prompts. If you have already created the account, |
| 38 | +sign in and continue from your current setup step. |
| 39 | + |
| 40 | +For a self-hosted deployment, **Use email/password** is the simplest account |
| 41 | +option. You can choose Slack or Teams sign-in if you already intend to use |
| 42 | +one of them. Use the setup token from the installer if Roomote requests it. |
| 43 | + |
| 44 | +**Check:** You can sign in to the Roomote dashboard and reach inference setup. |
| 45 | + |
| 46 | +## 2. Connect inference |
| 47 | + |
| 48 | +If you see **Configure inference**, choose **Use the Roomote provider** when |
| 49 | +offered, or **Configure my own provider**. Otherwise, setup opens directly |
| 50 | +at **Choose your LLM provider**. Select the service you use and follow its |
| 51 | +connection instructions. For example, [OpenRouter](/providers/inference/openrouter) and |
| 52 | +[Anthropic](/providers/inference/anthropic) use API keys; other providers may |
| 53 | +use an account sign-in or a model endpoint. |
| 54 | + |
| 55 | +Enter credentials in the configuration form. Keep API keys and other secrets |
| 56 | +out of the conversation. |
| 57 | + |
| 58 | +Roomote adds recommended models for supported providers. Start with those |
| 59 | +defaults; you can change models later in **Settings > Models**. If Roomote |
| 60 | +reports that the account has no credit or quota, resolve that with the |
| 61 | +provider before starting work. |
| 62 | + |
| 63 | +**Check:** Roomote opens a setup conversation and sends an introductory |
| 64 | +message. This conversation is saved, so you can return to it to continue |
| 65 | +setup. |
| 66 | + |
| 67 | +## 3. Connect one repository |
| 68 | + |
| 69 | +In the setup conversation, choose your source-control provider and open its |
| 70 | +configuration dialog. Follow the provider's authorization steps and grant |
| 71 | +access to your chosen repository. Start with one small, existing repository |
| 72 | +so you can easily inspect the first result. |
| 73 | + |
| 74 | +For [GitHub](/providers/source-control/github), **Create GitHub App** prepares |
| 75 | +the app configuration for you. Complete the GitHub flow and install the app |
| 76 | +on the account or organization that owns the repository. Other providers |
| 77 | +have their own guides, including [GitLab](/providers/source-control/gitlab) |
| 78 | +and [Gitea](/providers/source-control/gitea). |
| 79 | + |
| 80 | +**Check:** Return to the setup conversation and wait for Roomote to confirm |
| 81 | +that your repositories are available. If the repository is missing, check |
| 82 | +the provider connection and the app's repository permissions before |
| 83 | +continuing. |
| 84 | + |
| 85 | +## 4. Choose a small first task |
| 86 | + |
| 87 | +Roomote next offers integrations with other tools. Select **Keep going** to |
| 88 | +continue without connecting any for this guide. |
| 89 | + |
| 90 | +When Roomote offers starter tasks, choose **I'll type it myself** to skip |
| 91 | +the suggested tasks. Those tasks can make changes and open pull |
| 92 | +requests; the example below gives you a smaller first result to inspect. |
| 93 | +Automation recommendations are optional and can wait until your first task |
| 94 | +works. |
| 95 | + |
| 96 | +Enter this request in the message box in the same conversation, replacing |
| 97 | +`owner/repository` with the repository you connected: |
| 98 | + |
| 99 | +```text |
| 100 | +Run a task in a sandbox for owner/repository. Inspect the repository and |
| 101 | +summarize its top-level folders and the dependency-install and test commands |
| 102 | +already documented or defined in the project. Cite the files you used. If a |
| 103 | +command is missing, say so instead of inventing one. |
| 104 | +
|
| 105 | +Run git rev-parse --show-toplevel and git status --short in the repository |
| 106 | +and include the results so I can confirm the workspace is working. Keep |
| 107 | +this task read-only: do not edit files, commit, push, or open a pull request. |
| 108 | +``` |
| 109 | + |
| 110 | +You do not need to create an environment for this first task. Roomote can |
| 111 | +resolve the connected repository from your request. An |
| 112 | +[environment](/environments) is useful when you want to save repeatable setup |
| 113 | +commands, services, tool versions, or preview ports for later work. |
| 114 | + |
| 115 | +## 5. Confirm where the task will run |
| 116 | + |
| 117 | +If a sandbox provider is already configured, Roomote can start the task |
| 118 | +without another setup step. Keep the provider provisioned for your Cloud |
| 119 | +deployment or configured by your self-hosted installer. |
| 120 | + |
| 121 | +If Roomote asks for a sandbox, use its configuration controls to select and |
| 122 | +configure a provider: |
| 123 | + |
| 124 | +- for a single-host self-hosted deployment, [Docker](/providers/compute/docker) |
| 125 | + runs tasks on your server and needs no separate provider API key |
| 126 | +- for a hosted sandbox, follow the chosen provider's credential and setup |
| 127 | + instructions; see [Sandboxes](/compute) for the options |
| 128 | + |
| 129 | +You can also inspect or configure the default provider in **Settings > |
| 130 | +Sandboxes**. Return to the conversation after saving and continue your |
| 131 | +request if it has not started. |
| 132 | + |
| 133 | +For Docker, use **Validate environment** under **Settings > Sandboxes > |
| 134 | +Local Docker** to check the daemon, worker image, and release archive. |
| 135 | +Docker must also support writable-layer disk limits; the first task checks |
| 136 | +that when its container starts. If it reports an unsupported disk limit, |
| 137 | +follow the [Docker storage guidance](/providers/compute/docker#resource-and-network-isolation) |
| 138 | +or choose a hosted sandbox provider. |
| 139 | + |
| 140 | +**Check:** A task appears in the conversation and begins preparing its |
| 141 | +workspace. Open the task to follow progress. The first run may take longer |
| 142 | +while images and repository dependencies are prepared. |
| 143 | + |
| 144 | +## 6. Review the result |
| 145 | + |
| 146 | +When the task finishes, open its workspace and check: |
| 147 | + |
| 148 | +1. The overview matches the repository, and the commands point back to real |
| 149 | + project files. |
| 150 | +2. The command output identifies the repository's sandbox checkout. An empty |
| 151 | + `git status --short` result means the working tree is clean. |
| 152 | +3. The task left the repository unchanged, as requested. |
| 153 | + |
| 154 | +Expand command entries in the task transcript to inspect their output. If |
| 155 | +environment setup failed, open **Logs** and select the relevant |
| 156 | +`Setup: <command>` entry. See [Review a task](/tasks) for the other review |
| 157 | +tools. |
| 158 | + |
| 159 | +You now have a working path from your browser through inference, repository |
| 160 | +access, and sandbox execution to a result you can inspect. Continue in the |
| 161 | +same conversation with a small code change, ask Roomote to run the relevant |
| 162 | +checks, and review its diff before requesting a pull request. Future work can |
| 163 | +start from **New Session**; select a repository or environment when you |
| 164 | +already know where it should run. |
| 165 | + |
| 166 | +## If your first task gets stuck |
| 167 | + |
| 168 | +| What you see | What to check | |
| 169 | +| --- | --- | |
| 170 | +| The conversation fails before answering | Check the saved provider in **Settings > Models**, its credentials, and available credit or quota. | |
| 171 | +| Roomote cannot find or clone the repository | Check source-control authorization and repository permissions. On a self-hosted deployment, also check that the configured application URL is reachable for provider callbacks. | |
| 172 | +| The task cannot start its sandbox | Check **Settings > Sandboxes**. For Docker, inspect host capacity and the error in the task logs. For a hosted provider, check its credentials and connectivity to your deployment. | |
| 173 | +| A setup command or project check fails | Open the task logs. Add missing tools, services, or setup guidance through an [environment](/environments), then retry with that environment. | |
| 174 | + |
| 175 | +If a task failed to start, **Try in a new task** opens an editable request |
| 176 | +with its original prompt and context. Correct the problem before launching |
| 177 | +it again. |
| 178 | + |
| 179 | +## Continue setup later |
| 180 | + |
| 181 | +The setup conversation stays available when you leave the page. Its |
| 182 | +configuration cards also leave the message composer available, so you can |
| 183 | +keep talking while deciding what to connect. **Not now** skips an initial |
| 184 | +offer; Roomote can offer that capability again when later work needs it. |
| 185 | + |
| 186 | +Only deployment administrators can configure providers through these |
| 187 | +controls. Other members should ask an administrator to connect anything |
| 188 | +their task needs. If you chose a suggested starter task and its launch |
| 189 | +failed, ask Roomote to retry that item after fixing the problem; you do not |
| 190 | +need to repeat setup. |
| 191 | + |
| 192 | +## Add more when you need it |
| 193 | + |
| 194 | +- [Create an environment](/environments) to make your project's setup reusable. |
| 195 | +- [Connect Slack](/providers/communications/slack) or another communications |
| 196 | + provider if you want to start and follow work outside the dashboard. |
| 197 | +- [Connect integrations](/integrations/index) when a task needs context from |
| 198 | + your other tools. |
| 199 | +- [Set up automations](/automations) after you have verified the work you want |
| 200 | + Roomote to repeat. |
0 commit comments