1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>ship — deploy to your VPS</title>
<style>
:root {
--bg: #f5f2eb;
--fg: #2c2c2c;
--muted: #6b6b6b;
--accent: #1a1a1a;
--border: #d4d0c8;
}
* { margin: 0; padding: 0; box-sizing: border-box; }
body {
font-family: 'JetBrains Mono', 'IBM Plex Mono', ui-monospace, monospace;
font-size: 16px;
line-height: 1.6;
background: var(--bg);
color: var(--fg);
}
main {
max-width: 640px;
margin: 0 auto;
padding: 4rem 1.5rem;
}
h1 {
font-size: 1.5rem;
font-weight: 600;
margin-bottom: 0.5rem;
}
.tagline {
color: var(--muted);
margin-bottom: 3rem;
}
section {
margin-bottom: 3rem;
}
h2 {
font-size: 0.875rem;
font-weight: 600;
text-transform: uppercase;
letter-spacing: 0.05em;
color: var(--muted);
margin-bottom: 1rem;
}
p {
margin-bottom: 1rem;
}
pre {
background: var(--accent);
color: var(--bg);
padding: 1rem 1.25rem;
overflow-x: auto;
font-size: 0.875rem;
line-height: 1.7;
margin-bottom: 1rem;
}
code {
font-family: inherit;
}
.comment { color: #888; }
.output { color: #a0a0a0; }
ul {
list-style: none;
margin-bottom: 1rem;
}
li {
padding-left: 1.25rem;
position: relative;
margin-bottom: 0.5rem;
}
li::before {
content: "—";
position: absolute;
left: 0;
color: var(--muted);
}
a {
color: var(--fg);
text-decoration: underline;
text-underline-offset: 2px;
}
a:hover {
color: var(--muted);
}
.features {
display: grid;
gap: 1.5rem;
margin-bottom: 1rem;
}
.feature {
border: 1px solid var(--border);
padding: 1rem 1.25rem;
}
.feature strong {
display: block;
margin-bottom: 0.25rem;
}
.feature span {
color: var(--muted);
font-size: 0.875rem;
}
footer {
border-top: 1px solid var(--border);
padding-top: 2rem;
color: var(--muted);
font-size: 0.875rem;
}
</style>
</head>
<body>
<main>
<header>
<h1>ship</h1>
<p class="tagline">Deploy code to your VPS. Get a URL back.</p>
</header>
<section>
<h2>What it does</h2>
<p>Point ship at a directory or binary. It figures out what you're deploying, uploads it, configures HTTPS, and gives you a URL. No containers required. No YAML. No config files.</p>
<p>Built for AI agents. JSON output by default, predictable behavior, and an <a href="https://github.com/bdw/ship/tree/main/skill">agent skill</a> so your assistant can deploy code without hand-holding.</p>
</section>
<section>
<h2>Usage</h2>
<pre><span class="comment"># static site</span>
ship ./dist
<span class="output">→ https://ship-a1b2c3.example.com</span>
<span class="comment"># with a name</span>
ship ./dist --name docs
<span class="output">→ https://docs.example.com</span>
<span class="comment"># binary with health check</span>
ship ./myapp --name api --health /healthz
<span class="output">→ https://api.example.com</span>
<span class="comment"># temporary preview (auto-deletes)</span>
ship ./preview --ttl 1h
<span class="output">→ https://ship-x7y8z9.example.com (expires in 1h)</span>
<span class="comment"># custom domain</span>
ship ./site --domain myapp.com
<span class="output">→ https://myapp.com</span></pre>
</section>
<section>
<h2>Features</h2>
<div class="features">
<div class="feature">
<strong>Auto-detection</strong>
<span>Static sites, Docker apps, binaries — ship figures it out.</span>
</div>
<div class="feature">
<strong>Automatic HTTPS</strong>
<span>Caddy handles certificates. You get HTTPS by default.</span>
</div>
<div class="feature">
<strong>TTL support</strong>
<span>Temporary deploys that clean themselves up.</span>
</div>
<div class="feature">
<strong>JSON output</strong>
<span>Built for scripts and automation. Parseable by default.</span>
</div>
</div>
</section>
<section>
<h2>One-time setup</h2>
<pre><span class="comment"># point ship at your VPS</span>
ship host init user@your-server --domain example.com</pre>
<p>That's it. No manual VPS configuration. Init installs everything — Caddy, Docker, systemd services, SSH keys. Just bring a fresh VPS with SSH access (Ubuntu/Debian).</p>
</section>
<section>
<h2>Commands</h2>
<ul>
<li><code>ship <path></code> — deploy</li>
<li><code>ship list</code> — show all deployments</li>
<li><code>ship status <name></code> — check a deployment</li>
<li><code>ship logs <name></code> — view logs</li>
<li><code>ship remove <name></code> — take it down</li>
</ul>
</section>
<footer>
<p>Built for people who just want to put things on the internet.</p>
</footer>
</main>
</body>
</html>
|
