Tokens and permissions
You add each token once. It is tested the moment you add it, stored in your operating system’s keychain (Keychain on macOS, Credential Manager on Windows, Secret Service on Linux), and never written to a file or sent to this website.
On a machine without a keychain, such as CI, pass tokens as environment variables named SHIPYARD_CRED_<PROVIDER>_<FIELD>, for example SHIPYARD_CRED_GITHUB_TOKEN.
GitHub
Create it at github.com/settings/personal-access-tokens/new?name=Shipyard&description=Lets+Shipyard+create+the+repository+for+a+new+product+and+put+the+starter+code+in+it.&administration=write&contents=write, then run shipyard creds add github.
Set up once, before your first launch
- If your repos live in an organisation: allow fine-grained tokens there (Organisation settings, Personal access tokens, Allow access via fine-grained personal access tokens). Without it the token cannot see the organisation.
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| Administration: Read and write | Create the repository (and delete it, only if you ask destroy to). |
| Contents: Read and write | Commit the starter template, CLAUDE.md and the launch kit. |
| Metadata: Read-only | Required by GitHub for every fine-grained token. |
Creating the token
- Open the link. The name and the permissions are already filled in.
- Resource owner: your account, or the organisation your projects live in.
- Expiration: pick "No expiration", or the longest option offered.
- Repository access: All repositories (the new repository does not exist yet, so it cannot be selected).
- Check that Permissions shows Administration and Contents, both "Read and write". Add them if the link did not.
- Press Generate token and copy it. GitHub shows it only once.
Vercel
Create it at vercel.com/account/tokens, then run shipyard creds add vercel.
Set up once, before your first launch
- Install the Vercel GitHub app on the account that owns your repos, with access to all repositories, so Vercel can deploy from them. Open the page
- A product that takes money needs the Pro plan. The free Hobby plan is for non-commercial projects only. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| A token scoped to one team, or to your personal account | Vercel tokens are scoped to an account or a team, not more finely. Pick the one team the project should live in. |
Creating the token
- Open the link.
- Create a token. Under scope pick your personal account or one team, and set an expiry.
- Copy it and paste it into Shipyard.
Supabase
Create it at supabase.com/dashboard/account/tokens, then run shipyard creds add supabase.
Set up once, before your first launch
- Create an organisation if you have none. The free plan allows two active projects: pause or delete one if you already have two. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| A personal access token | Supabase access tokens act as your user. Shipyard creates one project in the organisation you name and does not touch your others. |
Creating the token
- Open the link.
- Generate a new token and give it a name.
- Copy it and paste it into Shipyard, with the slug of the organisation the project should live in.
Railway
Create it at railway.com/account/tokens, then run shipyard creds add railway.
Set up once, before your first launch
- Add a payment method and choose the Hobby plan ($5 a month). A trial account cannot attach a custom domain. Open the page
- Install the Railway GitHub app on the account that owns your repos, with access to all repositories, so Railway can deploy from them. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| Account token, or a token for one workspace | Railway tokens are not scoped more finely than a workspace. A workspace token is the narrowest that can create a project. |
Creating the token
- Open the link.
- Give the token a name, such as Shipyard. In the workspace list, pick the workspace your projects live in. Press Create.
- Copy the token. Railway shows it only once.
- Paste it into Shipyard. When Shipyard asks for a workspace ID, press Enter to skip it.
Cloudflare
Create it at dash.cloudflare.com/profile/api-tokens?permissionGroupKeys=%5B%7B%22key%22%3A%22zone%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22dns%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22workers_r2%22%2C%22type%22%3A%22edit%22%7D%2C%7B%22key%22%3A%22account_api_tokens%22%2C%22type%22%3A%22edit%22%7D%5D&accountId=%2A&zoneId=all&name=Shipyard, then run shipyard creds add cloudflare.
Set up once, before your first launch
- Add a card and make it the default payment method. Open the page
- To buy domains: on the Registrations page press Create default contact and fill in your name, address, email and phone. Write the phone as +country code, a dot, then the number without its leading 0, for example +31.612345678. Cloudflare may email a verification link to that address: click it. There is no separate agreement to accept after that. Do not buy a domain there and skip its Create Registrar API token button: Shipyard's token needs more permissions than that one has. Open the page
- Switch R2 on once. It uses the card above; the first 10 GB are free. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| Zone: Zone: Edit | Add the domain to Cloudflare DNS. |
| Zone: DNS: Edit | Write the records for hosting, email and Search Console. Only records Shipyard created are ever changed or removed. |
| Account: Registrar: Domains: Admin | Check availability and price, and register the domain after you confirm. Leave out if you never buy domains through Shipyard. |
| Zone: Email Routing Rules: Edit | Forward hello@yourdomain to your inbox. Leave out if you chose no mailbox. |
| Account: Email Routing Addresses: Edit | Register your inbox as the address mail is forwarded to. Leave out if you chose no mailbox. |
| Account: Workers R2 Storage: Edit | Create the file storage bucket. Leave out if you chose no storage. |
| Account: API Tokens: Edit | Mint S3 keys limited to that one bucket for your app. Without it Shipyard tells you how to create them by hand. |
Creating the token
- Open the link. The name Shipyard and four of the seven permissions are already filled in. If the page opens empty instead, press Create Token, name it Shipyard and press "Start from scratch (Custom)".
- Account policy (if you are asked, pick "Start with an Account policy" and choose your account). It needs four permissions: Registrar: Domains (found under DNS & Zones; tick Admin, and leave Registrar Sandbox Domains alone), Email Routing Addresses, Workers R2 Storage and API Tokens. Add the ones that are missing.
- Zone policy (press "+ Add new policy" under the list, pick "Start with a Zone policy", and leave it on all zones). It needs three permissions: Zone, DNS and Email Routing Rules. Add the ones that are missing.
- Finding a permission: type its name in the "Search for permission groups" box of that policy. Without searching, they sit under these headings: Registrar: Domains under DNS & Zones, Email Routing Addresses under Email & Messaging, Workers R2 Storage under Developer Platform, API Tokens under Account & Billing.
- Each permission has two boxes. Always tick the right-hand one: it is called Edit on most and Admin on some. Read alone is not enough.
- Do not pick "Start with a User policy".
- Token expiration: leave "No expiration". Client IP address filtering: leave empty.
- Press Continue to summary. Check that it shows two blocks: one with the four account permissions and one with the three zone permissions. If the zone block is missing, press Back and use "Add new policy".
- Press Create Token and copy it. Cloudflare shows it only once.
- Paste it into Shipyard. Leave the Account ID question empty: Shipyard finds it. It only asks you to choose if your login has more than one Cloudflare account.
Namecheap
Create it at ap.www.namecheap.com/settings/tools/apiaccess/, then run shipyard creds add namecheap.
Set up once, before your first launch
- Namecheap only enables the API for accounts with at least 20 domains, or $50 balance, or $50 spent in the last two years. Top up if you have none of these. Open the page
- API purchases are paid from account balance: top up enough to cover the domain. Open the page
- Set a default address. It is used as the registrant contact. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| API access (account-wide) | Namecheap has a single API key per account with no finer scopes. |
Creating the token
- Open the link and switch API Access on.
- Under Whitelisted IPs add the public IPv4 address of the machine that runs Shipyard.
- Copy the API key and paste it into Shipyard with your username and that IP.
Resend
Create it at resend.com/api-keys, then run shipyard creds add resend.
Set up once, before your first launch
- The free plan holds one domain. If you already have one there, remove it or move to a paid plan, or the new domain is refused. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| Full access | Adding and verifying a domain needs it. Your app never gets this key: Shipyard creates a separate sending-only key limited to the one domain. |
Creating the token
- Open the link, Create API Key.
- Permission: Full access.
- Copy it and paste it into Shipyard.
Stripe (test mode)
Create it at dashboard.stripe.com/test/apikeys, then run shipyard creds add stripe.
Set up once, before your first launch
- Nothing for test mode. To take real payments later, finish Stripe's business verification; it can take a day or more, so start it now. Open the page
What Shipyard does with it
Nothing to tick. The standard secret key already allows all of this; this is what Shipyard uses it for.
| Permission | Why Shipyard needs it |
|---|---|
| Products, prices and coupons | Create your pricing. |
| Webhook endpoints | Point Stripe at your live domain and read the signing secret once. |
| Customers and events | The health check creates and deletes one test customer to prove the webhook arrives. |
| Checkout sessions and subscriptions | Your app uses this same key to take payments. |
Creating the token
- Open the link. Check that Stripe is in test mode: the page says "Test mode" or "Sandbox", and the address contains /test/.
- Find the key named "Secret key" in the list. It is shown shortened, starting with sk_test_. Stripe translates the page, so in your language it may read differently, for example "Geheime sleutel" in Dutch.
- Press the small copy icon right next to it (on older pages the button reads "Reveal test key"). Stripe may ask you to confirm it is you.
- Do not take the Publishable key (pk_test_): that is the public one.
- Every Stripe account comes with a test secret key, so you normally create nothing. If the list is empty because it was deleted, press the button to create a secret key, name it Shipyard, pick the standard kind with full access if it asks (not "restricted"), and copy that.
- Paste it into Shipyard.
- For experts only: a restricted key (rk_test_) also works if it has Write on Products, Prices, Coupons, Webhook Endpoints, Customers, Checkout Sessions and Subscriptions, and Read on Events.
Stripe (live mode)
Create it at dashboard.stripe.com/apikeys, then run shipyard creds add stripe-live.
Set up once, before your first launch
- Finish Stripe's business verification. Until then Stripe refuses live charges. Open the page
What Shipyard does with it
Nothing to tick. It is only used when you switch a product to real payments, which asks you first.
| Permission | Why Shipyard needs it |
|---|---|
| The same as the test key | Create the same products, prices and webhook in live mode, and let your app take real payments. |
Creating the token
- Finish Stripe's business verification first. Until then there is no live key.
- Open the link. Check that Stripe is in live mode: test mode or sandbox is switched off, and the address has no /test/ in it.
- Find the key named "Secret key" and copy or reveal it. Stripe shows a live secret key only once: copy it straight away. If it cannot be shown any more, create a new secret key there and copy that.
- It starts with sk_live_. Paste it into Shipyard.
Google (Analytics and Search Console)
Create it at console.cloud.google.com/iam-admin/serviceaccounts, then run shipyard creds add google.
Set up once, before your first launch
- Create a Google Analytics account and accept its terms. Shipyard adds a property to it; it cannot create the account. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| analytics.edit | Create the GA4 property and its web stream. |
| siteverification | Prove you own the domain with a DNS record. |
| webmasters | Add the property to Search Console and submit the sitemap. |
Creating the token
- In Google Cloud create a project (any name), then a service account in it. No roles are needed.
- Enable three APIs in that project: Google Analytics Admin API, Site Verification API, Google Search Console API.
- Service account, Keys, Add key, JSON. A file downloads.
- In Google Analytics: Admin, Account access management, add the service account email as Editor.
- Give Shipyard the path to the file, your Analytics account ID and your own Google email.
Sentry
Create it at sentry.io/settings/account/api/auth-tokens/, then run shipyard creds add sentry.
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| project:read, project:write | Create the project and read its DSN. |
| project:admin | Delete the project on destroy. Leave out to keep projects. |
| team:read, org:read | Find the team the project goes in. |
Creating the token
- Open the link, Create New Token.
- Tick the scopes listed here.
- Paste the token and your organisation slug into Shipyard.
Anthropic
Create it at console.anthropic.com/settings/keys, then run shipyard creds add anthropic.
Set up once, before your first launch
- Add credit. A key on an account without credit passes the check and then fails in your app. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| A normal API key | Shipyard does not call Anthropic. It writes this key into each project so your app can. |
Creating the token
- Open the link, Create Key.
- Paste it into Shipyard.
OpenAI
Create it at platform.openai.com/api-keys, then run shipyard creds add openai.
Set up once, before your first launch
- Add credit. A key on an account without credit passes the check and then fails in your app. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| A project key, restricted to the endpoints your app uses if you like | Shipyard does not call OpenAI except to check the key. It writes this key into each project so your app can. |
Creating the token
- Open the link, Create new secret key.
- If you restrict it, keep read access to Models so Shipyard can check the key.
- Paste it into Shipyard.
OpenRouter
Create it at openrouter.ai/settings/keys, then run shipyard creds add openrouter.
Set up once, before your first launch
- Add credit. Without it only free models answer. Open the page
Permissions
| Permission | Why Shipyard needs it |
|---|---|
| A normal API key, with a credit limit if you like | Shipyard does not call OpenRouter except to check the key. It writes this key into each project so your app can. |
Creating the token
- Open the link, Create Key. Set a credit limit so a bug cannot run up a bill.
- Paste it into Shipyard.