shiplocal 0.1.1 → 0.1.2

package/README.md

@@ -20,15 +20,16 @@ Requires **Node.js 20+**.
 ### 1. Log in
 
 ```bash
-export SHIPLOCAL_API_URL=https://shiplocal.cloud
 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 (Next.js, Vite, Rails, etc.) on a port — for example **3000**:
+Run your project locally on a port — for example **3000**:
 
 ```bash
 npm run dev
@@ -36,10 +37,7 @@ npm run dev
 
 ### 3. Open a tunnel
 
-In a second terminal:
-
 ```bash
-export SHIPLOCAL_API_URL=https://shiplocal.cloud
 shiplocal 3000
 ```
 
@@ -69,30 +67,38 @@ Clients open the public URL, click **💬**, pick an element, and leave feedback
 | `shiplocal 3000`                   | Tunnel local port 3000            |
 | `shiplocal 3000 --password secret` | Password-protect the preview URL  |
 
-## Environment variables
+## Environment variables (optional)
 
-| Variable            | Default                 | Description                                                   |
-| ------------------- | ----------------------- | ------------------------------------------------------------- |
-| `SHIPLOCAL_API_URL` | `http://localhost:4000` | API server URL. Use `https://shiplocal.cloud` for production. |
-| `SHIPLOCAL_TOKEN`   | —                       | API token (alternative to `shiplocal login`)                  |
+| 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`.
+Credentials are saved to `~/.shiplocal/config.json` including the API URL from your last login.
 
-## Self-hosting
+**You do not need `export SHIPLOCAL_API_URL` for ShipLocal Cloud** — only set it if you use a custom server.
 
-To run your own ShipLocal server instead of ShipLocal Cloud, point `SHIPLOCAL_API_URL` at your 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) in the main repo.
+See the [self-hosting guide](https://github.com/ship-local/shiplocal/blob/main/docs/self-hosting.md).
 
 ## Troubleshooting
 
 **`command not found: shiplocal`**  
-Ensure npm global bin is on your PATH. Run `npm bin -g` and add that directory to your shell config.
+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.
@@ -100,9 +106,6 @@ Make sure your local app is running on the port you passed to the CLI.
 **`Not authenticated`**  
 Run `shiplocal login` first.
 
-**Wrong server / login fails**  
-Check `SHIPLOCAL_API_URL` is set to `https://shiplocal.cloud` for production.
-
 ## Links
 
 - [GitHub](https://github.com/ship-local/shiplocal)

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.1");
+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}.`,
       "",