@countrystatecity/cli 0.1.1 → 0.1.3

package/README.md

@@ -1,5 +1,10 @@
 # @countrystatecity/cli
 
+[![npm](https://img.shields.io/npm/v/@countrystatecity/cli)](https://www.npmjs.com/package/@countrystatecity/cli)
+[![CI](https://github.com/dr5hn/countrystatecity-npm/workflows/Pipeline/badge.svg)](https://github.com/dr5hn/countrystatecity-npm/actions/workflows/ci.yml)
+[![npm downloads](https://img.shields.io/npm/dm/@countrystatecity/cli?label=cli)](https://www.npmjs.com/package/@countrystatecity/cli)
+[![npm downloads](https://img.shields.io/npm/dw/@countrystatecity/cli?label=cli)](https://www.npmjs.com/package/@countrystatecity/cli)
+
 Official CLI for the [Country State City API](https://countrystatecity.in) — search, explore, and generate code from geographic data.
 
 ```bash
@@ -19,6 +24,16 @@ csc search countries
 csc get country IN
 ```
 
+## Global Flags
+
+These flags work on every command:
+
+| Flag | Short | Description |
+|------|-------|-------------|
+| `--json` | | Output raw JSON instead of formatted tables |
+| `--quiet` | `-q` | Suppress all decorative output (spinners, tips) |
+| `--no-footer` | | Hide the API usage footer after each command |
+
 ## Commands
 
 ### Authentication
@@ -27,7 +42,9 @@ csc get country IN
 csc auth login                # Interactive login with API key
 csc auth login --key <KEY>    # Login with key directly
 csc auth status               # Check current auth status
+csc auth status --json        # Returns { authenticated, key, tier, daily, monthly }
 csc auth logout               # Remove stored API key
+csc auth logout --json        # Returns { success: true }
 ```
 
 ### Search
@@ -56,9 +73,12 @@ csc search india
 # Detailed country info (timezones, coordinates, currency, etc.)
 csc get country IN
 csc get country US --json
+csc get country           # Interactive — prompts to pick a country (TTY only)
 
 # Detailed state info
 csc get state IN MH
+csc get state IN MH --json
+csc get state             # Interactive — prompts for country then state (TTY only)
 ```
 
 ### Usage & Billing
@@ -66,9 +86,11 @@ csc get state IN MH
 ```bash
 # View API usage with progress bars
 csc usage
+csc usage --json          # Returns { plan, price, daily, monthly }
 
 # View plans and open pricing page
 csc upgrade
+csc upgrade --json        # Returns { plans, currentPlan }
 ```
 
 ### Code Generation
@@ -88,9 +110,9 @@ csc generate seed --entity countries --format prisma
 csc generate seed -e states -f prisma --country IN
 csc generate seed -e cities -f prisma -c IN -s MH
 
-# Options
+# Options (apply to both dropdown and seed)
 --output <dir>     # Output directory (default: current directory)
---no-typescript    # Generate .jsx instead of .tsx
+--no-typescript    # Generate .jsx instead of .tsx  (dropdown only)
 ```
 
 #### Example: Generated Country Dropdown
@@ -126,6 +148,30 @@ async function main() {
 }
 ```
 
+### Interactive Explorer
+
+```bash
+# Launch an interactive browser: pick a country, then a state, then an action
+csc explore
+```
+
+From the action menu you can:
+- View all cities for the selected state
+- View full country or state details
+- Get the equivalent `csc generate` command to copy-paste
+
+> Requires an interactive terminal (TTY). Use `csc search` for scripts.
+
+### Export
+
+```bash
+# Open the online bulk export tool in your browser
+csc export
+
+# Get the export URL as JSON (useful for scripts)
+csc export --json
+```
+
 ## Tiers
 
 | Feature | Community (Free) | Starter ($5/mo) | Supporter ($9/mo) | Professional ($29/mo) | Business ($79/mo) |
@@ -140,6 +186,7 @@ async function main() {
 - [API Documentation](https://countrystatecity.in/docs/)
 - [Dashboard](https://app.countrystatecity.in)
 - [Pricing](https://app.countrystatecity.in/pricing)
+- [GitHub (monorepo)](https://github.com/dr5hn/countrystatecity-npm/tree/main/packages/cli)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@countrystatecity/cli",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Official CLI for the Country State City API - search, explore, and generate code from geographic data",
   "files": [
     "dist",
@@ -14,13 +14,6 @@
   "engines": {
     "node": ">=18"
   },
-  "scripts": {
-    "build": "tsup src/index.ts --format esm --dts --clean",
-    "dev": "tsx src/index.ts",
-    "test": "vitest",
-    "lint": "eslint src/",
-    "prepublishOnly": "npm run build"
-  },
   "keywords": [
     "country",
     "state",
@@ -36,9 +29,13 @@
   ],
   "author": "dr5hn",
   "license": "MIT",
+  "homepage": "https://github.com/dr5hn/countrystatecity-npm/tree/main/packages/cli#readme",
+  "bugs": {
+    "url": "https://github.com/dr5hn/countrystatecity-npm/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/dr5hn/countrystatecity-cli.git"
+    "url": "git+https://github.com/dr5hn/countrystatecity-npm.git"
   },
   "publishConfig": {
     "access": "public"
@@ -57,9 +54,15 @@
   "devDependencies": {
     "@types/node": "^22.0.0",
     "eslint": "^9.0.0",
-    "tsup": "^8.0.0",
-    "tsx": "^4.0.0",
+    "tsup": "^8.5.1",
+    "tsx": "~4.21.1",
     "typescript": "^5.7.0",
-    "vitest": "^3.0.0"
+    "vitest": "^4.1.8"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "dev": "tsx src/index.ts",
+    "test": "vitest",
+    "lint": "eslint src/"
   }
-}
+}