Skip to content
shiplet / docs

GETTING STARTED / 5 MINUTES

From your code
to your people.

Shiplet gives a working app a private home: inspect the repository, make the important decisions, deploy, then hand over one app-only link.

THE QUICK PATH
  1. ConnectChoose one approved repository
  2. ReviewCheck capabilities and access
  3. LaunchDeploy, verify, and share
Start setup ↗
Before you begin

Sign in with GitHub, connect the repositories you want Shiplet to access, and have your app’s required environment values ready.

Set up your first app →
01 / REPOSITORY

Start with the app you built.

Open the workspace and choose to import an app. Paste its GitHub repository URL. Shiplet inspects the project and reports the detected framework, build requirements, environment variable names, and capability findings.

Private repositories require an appropriate GitHub App installation. If the repository is missing, check the connected GitHub account and installation’s repository access.

Review the findings before continuing. A blocked inspection needs changes in the repository; findings requiring review need your acknowledgment.

02 / CONFIGURATION

Give the app what it needs.

Supply the required environment variables in setup. Values are stored encrypted; keep a separate secure copy because saved values are not displayed again.

Use the app’s expected variable names and verify external service credentials. Repository inspection can identify likely requirements, but you should still compare them with your app’s own setup instructions.

03 / DEPLOYMENT

Review, deploy, and follow progress.

Importing creates the application record. Deploying is a separate action. Review the plan and start the deploy when you are ready; a queued deployment does not mean the app is already live.

Follow its status in the console. When a build fails, inspect the build output first. For startup failures, check runtime logs, required variables, listening ports, and the app’s health behavior.

Keep costs visible

Sleep eligibility depends on the runtime; storage, traffic, and other provider resources can still incur costs while compute sleeps. In this beta, proposed Shiplet plan prices and AWS-reference estimates are not charges. Estimates are partial resource-visibility figures, not provider invoices or pass-through bills.

04 / ACCESS

Invite people to the app.

Wait for a successful, protected deployment before sharing. Use app invitations or share links according to your workspace’s sharing policy. Review the link’s audience and expiry before sending it.

App access and workspace access are separate. Someone who needs to use your app does not necessarily need permission to change deployments or workspace settings.

When your app needs more pieces.

Canvas lets you arrange services and connections, inspect configuration, and review a plan. Saving the diagram saves a draft; infrastructure changes require the explicit review and apply flow.

Common questions

Does signing in connect every repository?

No. Signing in establishes your identity. Repository access is managed through the GitHub App installation.

Can an agent do the setup?

Yes. The MCP endpoint exposes repository inspection, import, secret configuration, deployment, status, and sharing. Connect it with an agent key from your profile.

Next: connect your AI agent →