# Get started

Install the nesly CLI, deploy your first project and put it on your own domain.

## 1\. Install the CLI

macOS and Linux, with Homebrew:

```
brew install neslyhq/tap/nesly
```

Or download a release binary from [GitHub releases](https://github.com/neslyhq/platform/releases) and put it on your `PATH`.

Check it:

```
nesly --version
```

## 2\. Sign in

```
nesly login
```

The CLI prints a URL and a code; approve it in the browser. The token is stored in your user config directory, and `nesly whoami` shows who you are signed in as. Don't have an account yet? Create one at [console.nesly.net](https://console.nesly.net).

## 3\. Deploy

From your project directory:

```
cd my-app
nesly deploy --yes
```

The first run creates a project named after the directory, links this working copy to it (`.nesly/project.json`), builds your code and prints the live URL. After that, `nesly deploy` is enough.

What gets built:

-   A **Dockerfile** in the project root wins — we build exactly what it says.
-   A **frontend** (Vite, React, Astro, SvelteKit, Angular, Next.js…) is installed with your lockfile's package manager, built, and served as static files.
-   A **static site generator** outside the Node world (Hugo, Jekyll, MkDocs) is built with its own toolchain and served as static files.
-   Otherwise the stack is detected automatically (Node.js, Python, Go, .NET, Ruby, PHP, Java…) and run as a container.
-   A directory of static files with no server entry point is served as it is.

Nothing to configure for the common cases. When you need to say it yourself — a monorepo, a custom build command, a different output directory — see [builds](/docs/builds/).

Your app must listen on the port given in `PORT` and bind`0.0.0.0`, not `localhost`.

## 4\. Environment variables

```
nesly env set API_KEY=... STRIPE_KEY=...
nesly env ls
nesly env rm API_KEY
```

Changes apply to the _next_ deployment — running instances are never mutated in place. Deploy again to pick them up.

`.env` files are never uploaded, and neither is anything your `.gitignore` excludes.

Values are encrypted before they are written down (AES-256-GCM), and only ever decrypted to hand to your build and your running app. A viewer on your team can see that a variable exists, never what is in it.

Preview-only values, pasting a .env, and the names the platform adds: [environment variables](/docs/environment-variables/).

## 5\. Add a database, a key-value store or object storage

Attach a managed service; connection details arrive as environment variables on the next deploy. Full list: [addons](/docs/addons/).

`nesly addon add postgres` or `nesly addon add mssql` for a database; `nesly addon add valkey` for a Redis-compatible store (`REDIS_URL` and `VALKEY_URL`); `nesly addon add bucket` for S3-compatible object storage (`AWS_*`).

You get your own login; no other customer can reach it. **mssql** also injects `ConnectionStrings__Default` — a .NET app reads it with `GetConnectionString("Default")`, no configuration code at all.

## 6\. Your own domain

```
nesly domain add app.example.com
nesly domain verify app.example.com
```

The first command prints the DNS records to create (a `CNAME` and a`TXT` proving you own the name). Create them at your DNS provider, then verify. HTTPS is issued and renewed automatically; the project keeps its `.nesly.net` address too.

A **root domain** (`example.com`, with nothing in front of it) works the same way, but the record is different: DNS does not allow a`CNAME` at the root of a zone, so the command prints`A` records instead. Add`www.example.com` as a second domain if you want both to work.

Using our nameservers instead of records, HTTPS, and pinning an address to a release: [domains](/docs/domains/).

## 7\. When something goes wrong

```
nesly ls                      # deployments, newest first
nesly inspect dep_…           # one deployment in detail
nesly logs --follow           # build and runtime output
nesly rollback dep_…          # put a previous deployment back
```

A rollback is instant: it repoints traffic at a deployment that already exists, without rebuilding anything.

Previews, promote and gradual rollouts: [deployments](/docs/deployments/). Reading output: [logs](/docs/logs/). A terminal next to the running app:[shell](/docs/shell/).

## Limits worth knowing

-   Source uploads are capped at 512 MiB and 100,000 files.
-   Builds are given 15 minutes.
-   Free applications pause when idle and wake on the first request, which takes a few seconds. Pro keeps them warm.
-   Pull requests from forks are not deployed — see [GitHub](/docs/git/).
-   Each plan has an allowance — projects, domains, team members, build minutes and traffic: [limits](/docs/limits/).

Starting from a template instead of an empty directory: [templates](/templates/). Framework-specific notes (Next.js, Astro, FastAPI, ASP.NET…): [deploy guides](/deploy/nextjs/). Deploying from GitHub: [GitHub](/docs/git/). Build configuration: [builds](/docs/builds/). What each language builds on, and how to pin a version: [languages](/docs/languages/). Serving an image at the size the visitor will display: [images](/docs/images/). A game server, a broker or your own protocol: [services that are not websites](/docs/tcp/). Databases, a key-value store, object storage, backups and one-off commands: [addons](/docs/addons/),[backups & commands](/docs/backups/). Calling an AI model from your app with an OpenAI SDK: [AI models](/docs/ai-models/). Notifications, data export and closing an account: [your account](/docs/account/). Receiving those notifications on your own server: [webhooks](/docs/webhooks/). Sending your application's logs to your own log system: [log drains](/docs/log-drains/). What an error reason code means and what to run next: [errors](/docs/errors/). Working with an AI agent (MCP, diagnose): [for AI agents](/docs/agents/). Full command reference: [nesly CLI](/docs/cli/). Questions we have not answered here:[contact us](/contact/).

---
Canonical: https://nesly.net/docs/
Markdown: Accept: text/markdown on the HTML URL, or replace the trailing slash with .md
