domainstorm 0.2.0 → 0.2.1

package/README.md

@@ -1,99 +1,139 @@
-# Domainstorm CLI
+# Domainstorm
 
-`domainstorm` is a domain brainstorming + availability CLI for agent products.
-One command can generate naming candidates and check registration status via WHOIS.
+[![npm version](https://img.shields.io/npm/v/domainstorm)](https://www.npmjs.com/package/domainstorm)
+[![npm downloads](https://img.shields.io/npm/dm/domainstorm)](https://www.npmjs.com/package/domainstorm)
+[![CI](https://img.shields.io/github/actions/workflow/status/tanishqsh/domain-cli/npm-publish.yml)](https://github.com/tanishqsh/domain-cli/actions/workflows/npm-publish.yml)
 
-## Install
+Domainstorm is the fastest way to go from "we need a name" to "these are the domains we can buy now."
 
-From GitHub (works now):
+It is built for AI and agent products where naming cycles happen fast and every good domain disappears quickly.
 
-```bash
-npm i -g github:tanishqsh/domain-cli
-```
+## Why Domainstorm
 
-From npm (after publish):
+- One command for ideation and availability checks
+- Built for agent-native products (`agent`, `mcp`, `ops`, `runtime`, `router` naming patterns)
+- WHOIS-based checks across TLDs with optional registry server override
+- CLI-first output that works cleanly in agent and CI workflows
+- CSV export for founders, marketers, and legal review
+
+## Install
 
 ```bash
 npm i -g domainstorm
 ```
 
-Run without installing globally:
+Run instantly without global install:
 
 ```bash
-npx --yes github:tanishqsh/domain-cli#main --help
+npx --yes domainstorm --help
 ```
 
-## One-Command Brainstorm
+## Quick Wins
+
+Brainstorm + check + return only likely available:
 
 ```bash
-domainstorm --brainstorm "agent cli" "mcp broker" --tld md --server whois.nic.md --only-available
+domainstorm --brainstorm "agent orchestration" "mcp broker" --tld md --server whois.nic.md --only-available
 ```
 
-This command:
-- Generates brandable name candidates from your seed phrases
-- Appends your target TLD
-- Checks registration status
-- Prints a narrative hint (`story=...`) for each candidate
-
-## Quick Start
+Check exact domains:
 
 ```bash
-domainstorm openai.com example.org --output /tmp/domain-results.csv
+domainstorm agentmesh.ai agentmesh.com agentmesh.md
 ```
 
+Check from file and export CSV:
+
 ```bash
-domainstorm --input agent-md-candidates.txt --tld md --server whois.nic.md --output /tmp/md-results.csv
+domainstorm --input domains.txt --output /tmp/domainstorm.csv
 ```
 
-`domain-check` is kept as a compatibility alias.
+## Built For Agent Workflows
+
+Use Domainstorm when your coding/research agent needs to propose names and validate them in the same run.
 
-## Input Format
+- Deterministic CLI output
+- Works with shell pipelines
+- No external AI API keys required
+- Easy to trigger in CI on release or branch workflows
 
-- One label/domain per line in a text file
-- `#` comments are ignored
-- Labels without a TLD are converted to `<label>.<tld>` (default: `md`)
-- Comma-separated values are accepted per line
+Compatibility alias:
 
-Example:
+```bash
+domain-check --help
+```
+
+## Example Output
 
 ```txt
-# sample
-broker
-agenthub.md
-mcpbroker,mcprouter
+agentmesh.md    likely_available    availability_pattern_match    low    story=Keyword + product framing
+agentops.md     registered          registration_pattern_match    low    story=Keyword + product framing
 ```
 
-## Output Columns
+Output columns:
 
 - `domain`
-- `status`: `registered`, `likely_available`, or `unknown`
-- `reason`: why the status was chosen
-- `legal_risk`: heuristic trademark risk flag (`low` / `high_tm_risk`)
-- `story`: brainstorm narrative tag for generated names
-- `error`: lookup/system failures when present
+- `status` (`registered`, `likely_available`, `unknown`)
+- `reason`
+- `legal_risk` (`low`, `high_tm_risk`)
+- `story` (brainstorm narrative tag)
+- `error`
 
-## CLI Flags
+## Key Flags
 
+- `--brainstorm` / `--storm`
+- `--max-suggestions <n>` (default: `120`)
 - `--input <file>`
 - `--output <file>`
-- `--tld <tld>` default `md`
-- `--server <whois-host>` optional (for example `whois.nic.md`)
+- `--tld <tld>` (default: `md`)
+- `--server <whois-host>`
+- `--only-available`
 - `--concurrency <n>`
 - `--timeout-ms <n>`
-- `--brainstorm` / `--storm`
-- `--max-suggestions <n>` default `120`
-- `--only-available`
 - `--raw`
 
-## Notes
+## Add `NPM_TOKEN` In GitHub (2 Minutes)
+
+1. Create an npm Automation token:
+`npmjs.com -> Account Settings -> Access Tokens -> Generate New Token -> Automation`
+2. Open your repo:
+`github.com/tanishqsh/domain-cli`
+3. Go to:
+`Settings -> Secrets and variables -> Actions`
+4. Click:
+`New repository secret`
+5. Set:
+`Name = NPM_TOKEN`
+`Secret = <your npm automation token>`
+6. Save.
+
+Now GitHub Actions can publish with `.github/workflows/npm-publish.yml`.
+
+## GitHub -> npm Auto Publish
+
+The publish workflow triggers on:
 
-- WHOIS formats vary by registry; treat `likely_available` as a pre-check, not final registrar confirmation.
-- Registries can rate-limit bulk lookups; retry unknown rows after cooldown.
-- `whois` must be installed locally (`brew install whois` on macOS).
+- GitHub Release published
+- Manual `workflow_dispatch`
 
-## Publish To npm
+Workflow path:
+
+`/.github/workflows/npm-publish.yml`
+
+Important:
+
+- Bump `package.json` version before publishing a new release
+- npm will reject already-published versions
+
+## Local Publish
 
 ```bash
 npm login
 npm publish --access public
 ```
+
+## Notes
+
+- WHOIS formats vary by registry; treat `likely_available` as a pre-check, not final registrar checkout.
+- Registries can rate-limit bulk lookups; retry `unknown` rows after cooldown.
+- Install `whois` locally (`brew install whois` on macOS).

package/package.json

@@ -1,27 +1,45 @@
 {
   "name": "domainstorm",
-  "version": "0.2.0",
-  "description": "Domainstorm CLI: brainstorm brandable names and check domain registration via WHOIS",
+  "version": "0.2.1",
+  "description": "Brainstorm and check domain names in one command.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tanishqsh/domain-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tanishqsh/domain-cli/issues"
+  },
+  "homepage": "https://github.com/tanishqsh/domain-cli#readme",
   "type": "module",
   "bin": {
-    "domainstorm": "check-md-domains.mjs",
-    "domain-check": "check-md-domains.mjs"
+    "domainstorm": "check-domains.mjs",
+    "domain-check": "check-domains.mjs"
   },
   "files": [
-    "check-md-domains.mjs",
-    "agent-md-candidates.txt",
+    "check-domains.mjs",
+    "agent-candidates.txt",
     "README.md"
   ],
   "scripts": {
-    "start": "node check-md-domains.mjs --help"
+    "check": "node check-domains.mjs --help > /dev/null",
+    "start": "node check-domains.mjs --help"
   },
   "keywords": [
     "domain",
+    "domains",
     "whois",
     "cli",
-    "availability"
+    "availability",
+    "brainstorm",
+    "branding",
+    "agents",
+    "naming"
   ],
   "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "engines": {
     "node": ">=18"
   }