peakurl 0.0.3 → 0.1.0

package/README.md

@@ -2,123 +2,87 @@
 
 `peakurl` is the official command-line interface for PeakURL.
 
+It gives you a fast way to create, inspect, list, and remove short links from the terminal while keeping default output readable for humans and optional `--json` output friendly for scripts.
+
 ## Install
 
+Requirements: Node.js 20 or later.
+
 ```bash
 npm install -g peakurl
 ```
 
-The npm package name is unscoped and the executable is also `peakurl`.
-
-## Authentication
-
-The CLI uses a PeakURL API key and validates it with `GET /api/v1/users/me` before storing it.
-PeakURL API keys are opaque 48-character hex bearer tokens, for example `0123456789abcdef0123456789abcdef0123456789abcdef`.
-The CLI accepts either the site root URL such as `https://peakurl.org` or the dashboard-exposed API base URL such as `https://peakurl.org/api/v1`.
+## Quick Start
 
 ```bash
 peakurl login --base-url https://peakurl.org --api-key 0123456789abcdef0123456789abcdef0123456789abcdef
+peakurl create https://example.com/articles/launch --alias launch --title "Launch Post"
+peakurl list
+peakurl whoami
 ```
 
-You can also provide credentials through environment variables, which is useful in CI:
+## Authentication
+
+The CLI uses PeakURL bearer API keys and validates them with `GET /api/v1/users/me` before storing them.
+
+- `--base-url` accepts either the site root such as `https://peakurl.org` or the API base URL such as `https://peakurl.org/api/v1`
+- API keys are opaque 48-character hex tokens
+- credentials are stored in the standard per-user config location for `peakurl`
+
+For CI and automation, you can also use environment variables:
 
 ```bash
 export PEAKURL_BASE_URL=https://peakurl.org
 export PEAKURL_API_KEY=0123456789abcdef0123456789abcdef0123456789abcdef
 ```
 
-Stored credentials live in the OS-standard per-user config directory for `peakurl`.
-
 ## Commands
 
-### `peakurl login`
-
-```bash
-peakurl login --base-url https://peakurl.org --api-key 0123456789abcdef0123456789abcdef0123456789abcdef
-```
-
-### `peakurl whoami`
+| Command                        | Description                                 |
+| ------------------------------ | ------------------------------------------- |
+| `peakurl login`                | Validate and save your PeakURL credentials. |
+| `peakurl whoami`               | Show the current authenticated account.     |
+| `peakurl create <url>`         | Create a new short link.                    |
+| `peakurl list`                 | List links in your account.                 |
+| `peakurl get <id-or-alias>`    | Fetch a single link by ID or alias.         |
+| `peakurl delete <id-or-alias>` | Delete a link by ID or alias.               |
 
-```bash
-peakurl whoami
-peakurl whoami --json
-```
+## Common Flags
 
-### `peakurl create <url>`
+- `--json` prints machine-readable JSON output
+- `--quiet` minimizes output for scripts
 
-```bash
-peakurl create https://example.com/articles/launch --alias launch --title "Launch Post"
-peakurl create https://example.com --json
-```
+## Examples
 
-### `peakurl list`
+Create a short link:
 
 ```bash
-peakurl list
-peakurl list --search launch --limit 10 --json
+peakurl create https://example.com --alias example --title "Example"
 ```
 
-### `peakurl get <id-or-alias>`
+List links as JSON:
 
 ```bash
-peakurl get launch
-peakurl get 681f3b63e7e44c0a1e83aa11 --json
+peakurl list --limit 10 --json
 ```
 
-### `peakurl delete <id-or-alias>`
+Inspect a link:
 
 ```bash
-peakurl delete launch
-peakurl delete 681f3b63e7e44c0a1e83aa11 --quiet
+peakurl get example
 ```
 
-When you pass an alias or short code to `delete`, the CLI resolves it to the
-stable PeakURL row ID first because the current backend delete route operates on
-IDs.
-
-## Flags
-
-Common flags:
-
-- `--json` prints machine-readable output.
-- `--quiet` prints minimal output for scripts.
-
-Create flags:
-
-- `--alias`
-- `--title`
-- `--password`
-- `--status`
-- `--expires-at`
-- `--utm-source`
-- `--utm-medium`
-- `--utm-campaign`
-- `--utm-term`
-- `--utm-content`
-
-List flags:
-
-- `--page`
-- `--limit`
-- `--search`
-- `--sort-by`
-- `--sort-order`
-
-## Development
+Delete a link:
 
 ```bash
-npm install
-npm run build
-npm run typecheck
-npm test
+peakurl delete example
 ```
 
-Production builds emit the published executable at `bin/peakurl.js`.
-
-## Release
+When `delete` receives an alias or short code, the CLI resolves it to the underlying PeakURL row ID before deleting it.
 
-GitHub Actions publishes the CLI to the public npm registry when a GitHub
-Release is published.
+## Links
 
-The workflow expects a repository secret named `NPM_TOKEN` and publishes to
-`https://registry.npmjs.org/` with provenance enabled.
+- Website: https://peakurl.org/
+- API docs: https://peakurl.org/docs/api
+- npm package: https://www.npmjs.com/package/peakurl
+- Issues: https://github.com/PeakURL/PeakURL-CLI/issues

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "peakurl",
-    "version": "0.0.3",
+    "version": "0.1.0",
     "description": "PeakURL command-line interface",
+    "homepage": "https://peakurl.org/",
     "repository": {
         "type": "git",
-        "url": "https://github.com/PeakURL/PeakURL-CLI.git"
+        "url": "git+https://github.com/PeakURL/PeakURL-CLI.git"
     },
     "type": "module",
     "bin": {