Getting started
New to hosting? Start here
Put an app online from one box, read your projects at a glance, fix a failed deploy with one button, and ask CLI in plain words.
You don't need to know about servers, containers or ports to use CLI. This page covers the parts of the dashboard made for getting something online without that.
Put something online
The Put something online box is at the top of the Projects page, and on the first screen after you sign in.
- Paste a GitHub link, like
github.com/you/my-app. Links to a folder or branch work too. So doesyou/my-app. - Press Deploy.
Signed in with GitHub? Your most recently changed repos show under the box: click one instead of pasting a link. Every push to that repo's default branch deploys again on its own.
CLI then:
- makes a project named after the repo;
- reads the repo and works out what it is (Next.js, Express, Django, a static site and so on), which port it uses and how to start it;
- adds a database if the code uses one (Postgres, MySQL, Redis or MongoDB) and connects the app to it;
- deploys it, and shows its link when it's up.
If the repo has a .env.example file, CLI reads it. Values CLI can fill in itself, like a database address, are filled in for you. Every other variable is put on the app's Variables tab, with its example value where it isn't a secret and empty where only you know it (an API key, say). Secret-looking ones are saved as secrets. CLI then shows Fill in …, which opens that tab.
Code that isn't on GitHub? Drop the folder, or a .zip of it, on the box, or press Choose a folder or Choose a .zip. CLI leaves out node_modules, .git, build caches and .env files (it keeps .env.example), reads the rest the same way, and uploads it. The limit is 5,000 files and 100 MB. To update it later, upload again from the app's page or use cli up.
No code yet? Pick a starter under the box: a landing page, a waitlist, an AI chatbot, a Next.js or FastAPI app with Postgres, a Discord bot or a cron job. Each shows what it costs a month, and asks its questions (like the Discord bot's token) before it starts. The landing page, waitlist and chatbot sleep after 30 minutes with no visitors and wake on the next visit, so they usually cost much less than the "up to" price. See Starters.
What it costs. After it starts, CLI says about what the app costs a month while it runs. Every new project also has a monthly spending cap ($25 on clicloud.app). At 80% you get a warning. At the cap the apps stop until next month, so there's no surprise bill. The project page shows this month's spending against the cap, with Change to raise or remove it. See Credit, pricing and billing.
No credit yet? The app is still set up. CLI says what's left: press Add credit, then Finish, and CLI adds what's missing and deploys.
To read a GitHub repo, CLI needs access to it. If you haven't linked GitHub, CLI uses the repo's public address, which works for public repos. To use a private repo, link GitHub on the Account page.
For agents and scripts, the same thing is one call:
POST /v1/launch{ "repo": "https://github.com/you/my-app", "vars": { "SITE_NAME": "My shop" }, "secretVars": { "STRIPE_SECRET_KEY": "sk_live_…" } }For code from a folder, send { "upload": { "files": { "package.json": "<its contents>", "index.js": null, … }, "name": "my-app" } }: every path, with the contents of the files detection reads (package.json, requirements.txt, Dockerfile, .env.example and the like). The app is made without deploying, and the answer's uploadTo takes the code as a gzipped tarball (content-type: application/gzip), which deploys it.
The answer lists:
- what CLI found;
- the databases it added;
added: the.env.examplevariables it put on the app;missing: the variables that still need a value;- the deploy;
monthly: the cost per month while everything runs;cap: the project's monthly cap. If something stopped it (blocked, like no credit), call it again with{ "resume": "<the app's id>" }once that's sorted. Anything already done is skipped. Use{ "template": "<id>" }instead ofrepoto start from a template.
Your projects at a glance
Each project on the Projects page is a card. Along its line are its apps, each with a light: green is working, red is down, yellow is starting, grey is asleep or off. Its databases sit underneath. The card's last line shows how many apps are working, what the project costs a month, and the credit left.
Projects that need you come first: something down, paused for credit, or about to run out of credit. A project whose newest deploy failed shows Fix. The search box finds projects and the apps in them.
Agents can read the same view with GET /v1/overview.
Inside a project: Simple and Advanced
A project opens in Simple view, with four tabs: Apps, Activity, Usage and credit, and Settings. Each app is a card showing:
- whether it's working;
- its link;
- what it costs a month while it runs;
- buttons for Open, Logs and Settings, plus Fix it for me when it's down, or Deploy when it isn't running yet.
Databases are listed below the apps.
Advanced shows the full map you can drag around, health checks and every tool. The dashboard remembers your choice.
Reading logs
Build and app logs open in a plain view. Setup noise, like package downloads, progress bars and image layers, is hidden, and the lines that explain a failure are marked in red. Show everything brings back the full output, and the dashboard remembers your choice.
Fix it for me
Fix it for me shows on a failed deploy: on the app's card, on its deploy list and on the deploy's page. CLI reads why the deploy failed. It then fixes what it safely can, asks you for what only you know, or explains what has to change.
| What went wrong | What CLI does |
|---|---|
| A value the app needs isn't set | Shows a form for just that value, then sets it and deploys again |
| The app listens on a different port | Sends traffic to the right port and deploys again |
| The app never answered its health check | Checks / instead and deploys again |
| It ran out of memory | Offers more memory, with what it adds to the monthly cost, and waits for your yes |
| CLI couldn't tell how to build it | Finds the app's folder in the repo and builds from there |
| A variable points at a database that doesn't exist | Offers to add that database |
| A problem on CLI's side | Deploys again |
| A problem in the code | Explains it in plain words. For GitHub repos, CLI can open a pull request with a fix |
Every change is listed, so you can see what changed. CLI never spends more without asking. Agents call POST /v1/deploys/:id/autofix, adding { "confirm": true } to accept a change that costs more, or { "vars": { … } } to give the missing values.
Your own domain
Press Add your domain on an app's card. Type the domain, and CLI tells you who runs its DNS (Cloudflare, GoDaddy, Namecheap and so on), where to click there, and exactly what to type in each field, with copy buttons. It keeps checking while the steps are open and says when the domain works. See Domains and networking.
Ask CLI
The Ask CLI button at the bottom right of every page opens a chat about one project. Ask in your own words: "why is my site down?", "what's costing the most?", "how do I add my domain?".
CLI looks things up itself: deploy status, logs, health and usage. It works only in that project and with your access. It never changes anything on its own. When a change would help, like deploying again or adding a database, it shows a button. Nothing happens until you press it.
Answers are billed to the project's credit at CLI's model prices, like hosted agents. Each project has a daily limit. Ask CLI shows only when the server has CLI's model set up.