# Coolship

> A project-local developer CLI for Coolify: link a repository to its Coolify application once, then deploy, read logs, and sync variables from the terminal.

This index lists every page of the Coolship documentation at https://coolship.itrocas.com/docs. Append `.md` to a page URL (or request it with `Accept: text/markdown`) to read that page as Markdown, or fetch https://coolship.itrocas.com/llms-full.txt for the whole documentation in one file. Coolship is verified against Coolify 4.3.18.

## Overview

- [Overview](https://coolship.itrocas.com/docs): Coolship is a project-local developer CLI for Coolify. Link a repository to its Coolify application once, then deploy, read logs, and sync variables from the terminal.
- [Get started](https://coolship.itrocas.com/docs/get-started): Install Coolship, log in to your Coolify instance, link a repository, deploy it, and read its logs.

## Concepts

- [Project binding](https://coolship.itrocas.com/docs/concepts/project-binding): The committed coolship.toml file that ties a repository to a Coolify application, in its single and named-target forms.
- [Credentials](https://coolship.itrocas.com/docs/concepts/credentials): Where Coolship finds a Coolify URL and token, how it shares them with coolify-cli, and how CI supplies them.
- [Environment variables](https://coolship.itrocas.com/docs/concepts/variables): The two scopes Coolify keeps per application, withheld values, shared references, and what each command does with them.
- [Deployments](https://coolship.itrocas.com/docs/concepts/deployments): What coolship deploy does and does not do, how a deployment is observed, and how interruptions and uncertainty are handled.
- [Preview deployments](https://coolship.itrocas.com/docs/concepts/previews): How Coolship deploys pull-request previews, and why Coolify must already know the pull request.
- [Server compatibility](https://coolship.itrocas.com/docs/concepts/server-compatibility): Coolship is verified against Coolify 4.3.18. What the verification covered, what the server was observed to do, and what other versions can expect.

## Commands

- [Command reference](https://coolship.itrocas.com/docs/commands): Every Coolship command, the options they all share, and the conventions for prompts, output, and exit codes.
- [init](https://coolship.itrocas.com/docs/commands/init): Create a Coolify application for this repository from its Git remote, then link it exactly as link would.
- [link](https://coolship.itrocas.com/docs/commands/link): Bind this repository to an existing Coolify application and write coolship.toml.
- [unlink](https://coolship.itrocas.com/docs/commands/unlink): Delete coolship.toml. Nothing on the Coolify server changes.
- [status](https://coolship.itrocas.com/docs/commands/status): Inspect the linked application's current status and URL.
- [deploy](https://coolship.itrocas.com/docs/commands/deploy): Deploy the linked application using the source and branch already configured in Coolify, and observe exactly that deployment.
- [logs](https://coolship.itrocas.com/docs/commands/logs): Read runtime logs from the linked application, once or by following snapshots.
- [open](https://coolship.itrocas.com/docs/commands/open): Open the linked application's URL, or its Coolify page, in the default browser, and always print it.
- [doctor](https://coolship.itrocas.com/docs/commands/doctor): Run every step a command performs and report each one, with a failing exit status when a check fails.
- [config](https://coolship.itrocas.com/docs/commands/config): Show the effective configuration for this directory after overrides, reading files only.
- [env](https://coolship.itrocas.com/docs/commands/env): Pull, compare, and push environment variables between a local dotenv file and one scope of the linked application's variables.
- [preview](https://coolship.itrocas.com/docs/commands/preview): Deploy the preview deployment Coolify already holds for a pull request, and observe it like deploy does.
- [dev](https://coolship.itrocas.com/docs/commands/dev): Run a local command in the application root with the linked application's runtime variables injected over your environment.
- [domain](https://coolship.itrocas.com/docs/commands/domain): Show the linked application's domains, or replace them with domain set.
- [login and logout](https://coolship.itrocas.com/docs/commands/login): Save a Coolify instance URL and API token in the Coolify CLI configuration after verifying them, or remove a saved instance.

## Guides

- [Deploy from CI](https://coolship.itrocas.com/docs/guides/ci): Use Coolship in GitHub Actions with COOLSHIP_URL and COOLSHIP_TOKEN, deploy on push, and deploy pull-request previews.
- [Monorepos](https://coolship.itrocas.com/docs/guides/monorepos): Bind several Coolify applications in one repository with named targets, selected by directory or by name.
- [Environment-variable workflow](https://coolship.itrocas.com/docs/guides/environment-variables): Pull the application's variables into .env, edit locally, review the diff, push, and run locally with the real values.

## Platform

- [Limits](https://coolship.itrocas.com/docs/platform/limits): What Coolship does not do, mostly because the Coolify API does not allow it, and how it behaves at those edges.
- [Output and exit codes](https://coolship.itrocas.com/docs/platform/output): Which stream carries what, when output is styled, what --format json prints, and what each exit code means.
- [Docs for AI assistants](https://coolship.itrocas.com/docs/platform/ai): This documentation is published as Markdown too, with an llms.txt index and a Markdown rendition of every page, so assistants and agents can read it directly.