shiplocal 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,117 @@
+# ShipLocal CLI
+
+> From localhost to client-ready.
+
+Share your local dev server with clients via a public URL. Clients can leave visual feedback on the live preview.
+
+**Dashboard:** https://app.shiplocal.cloud  
+**Website:** https://shiplocal.cloud
+
+## Install
+
+```bash
+npm install -g shiplocal
+```
+
+Requires **Node.js 20+**.
+
+## Quick start
+
+### 1. Log in
+
+```bash
+shiplocal login
+```
+
+Create an account at https://app.shiplocal.cloud if you don't have one.
+
+No `export` needed — the CLI defaults to **https://shiplocal.cloud** and saves your server URL when you log in.
+
+### 2. Start your local app
+
+Run your project locally on a port — for example **3000**:
+
+```bash
+npm run dev
+```
+
+### 3. Open a tunnel
+
+```bash
+shiplocal 3000
+```
+
+You'll get output like:
+
+```
+🚀 ShipLocal running
+
+Local:   http://localhost:3000
+Public:  https://happy-lion.shiplocal.cloud
+
+Share this with your client.
+```
+
+Share the **Public** URL with your client. Keep this terminal open while they view the preview.
+
+### 4. Client feedback
+
+Clients open the public URL, click **💬**, pick an element, and leave feedback. You see comments and screenshots on your [dashboard](https://app.shiplocal.cloud/dashboard).
+
+## Commands
+
+| Command                            | Description                       |
+| ---------------------------------- | --------------------------------- |
+| `shiplocal login`                  | Authenticate with ShipLocal Cloud |
+| `shiplocal logout`                 | Remove saved credentials          |
+| `shiplocal 3000`                   | Tunnel local port 3000            |
+| `shiplocal 3000 --password secret` | Password-protect the preview URL  |
+
+## Environment variables (optional)
+
+| Variable            | When to use                                                    |
+| ------------------- | -------------------------------------------------------------- |
+| `SHIPLOCAL_API_URL` | Self-hosted server or local dev (e.g. `http://localhost:4000`) |
+| `SHIPLOCAL_TOKEN`   | Skip `login` by providing an API token directly                |
+
+Credentials are saved to `~/.shiplocal/config.json` including the API URL from your last login.
+
+**You do not need `export SHIPLOCAL_API_URL` for ShipLocal Cloud** — only set it if you use a custom server.
+
+### Local development against your own server
+
+```bash
+export SHIPLOCAL_API_URL=http://localhost:4000
+shiplocal login
+shiplocal 3000
+```
+
+## Self-hosting
+
+```bash
+export SHIPLOCAL_API_URL=https://your-server.example.com
+shiplocal login
+```
+
+See the [self-hosting guide](https://github.com/ship-local/shiplocal/blob/main/docs/self-hosting.md).
+
+## Troubleshooting
+
+**`command not found: shiplocal`**  
+Run `npm bin -g` and add that directory to your PATH.
+
+**Blank page on public URL**  
+Make sure your local app is running on the port you passed to the CLI.
+
+**`Not authenticated`**  
+Run `shiplocal login` first.
+
+## Links
+
+- [GitHub](https://github.com/ship-local/shiplocal)
+- [Dashboard](https://app.shiplocal.cloud)
+- [Issues](https://github.com/ship-local/shiplocal/issues)
+
+## License
+
+MIT

package/dist/index.js

@@ -4444,8 +4444,16 @@ async function clearConfig() {
   } catch {
   }
 }
-function resolveApiUrl() {
-  return process.env["SHIPLOCAL_API_URL"] ?? "http://localhost:4000";
+var DEFAULT_CLOUD_API_URL = "https://shiplocal.cloud";
+async function resolveApiUrlAsync() {
+  if (process.env["SHIPLOCAL_API_URL"]) {
+    return process.env["SHIPLOCAL_API_URL"];
+  }
+  const config = await loadConfig();
+  if (config?.apiUrl) {
+    return config.apiUrl;
+  }
+  return DEFAULT_CLOUD_API_URL;
 }
 async function resolveToken() {
   if (process.env["SHIPLOCAL_TOKEN"]) return process.env["SHIPLOCAL_TOKEN"];
@@ -4479,16 +4487,17 @@ function formatServerConnectionError(apiUrl, err) {
   }
   return err instanceof Error ? err.message : "Request failed";
 }
-async function postJson(path, body, apiUrl = resolveApiUrl()) {
+async function postJson(path, body, apiUrl) {
+  const baseUrl = apiUrl ?? await resolveApiUrlAsync();
   let response;
   try {
-    response = await fetch(`${apiUrl}${path}`, {
+    response = await fetch(`${baseUrl}${path}`, {
       method: "POST",
       headers: { "Content-Type": "application/json" },
       body: JSON.stringify(body)
     });
   } catch (err) {
-    throw new Error(formatServerConnectionError(apiUrl, err));
+    throw new Error(formatServerConnectionError(baseUrl, err));
   }
   const data = await response.json().catch(() => ({}));
   return { response, data };
@@ -4519,10 +4528,10 @@ function isLocalPortOpen(port, timeoutMs = 2e3) {
 
 // src/index.ts
 var program = new Command();
-program.name("shiplocal").description("Share localhost with clients in seconds").version("0.1.0");
+program.name("shiplocal").description("Share localhost with clients in seconds").version("0.1.2");
 program.command("login").description("Authenticate with ShipLocal Cloud").action(async () => {
   const rl = createInterface({ input, output });
-  const apiUrl = resolveApiUrl();
+  const apiUrl = await resolveApiUrlAsync();
   try {
     const email = await rl.question("Email: ");
     const password = await rl.question("Password: ");
@@ -4556,7 +4565,7 @@ program.argument("[port]", "Local port to expose", String(DEFAULT_TUNNEL_PORT)).
     console.error("Error: port must be a number between 1 and 65535");
     process.exit(1);
   }
-  const serverUrl = resolveApiUrl();
+  const serverUrl = await resolveApiUrlAsync();
   const token = await resolveToken();
   if (!token) {
     console.error("Not authenticated. Run `shiplocal login` first.");
@@ -4612,7 +4621,7 @@ program.argument("[port]", "Local port to expose", String(DEFAULT_TUNNEL_PORT)).
   try {
     await client.connect();
   } catch (err) {
-    const apiUrl = resolveApiUrl();
+    const apiUrl = await resolveApiUrlAsync();
     const message = err instanceof Error && err.message.includes("ECONNREFUSED") ? [
       `Cannot reach ShipLocal server at ${apiUrl}.`,
       "",