@fredlackey/cli-namecheap 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +33 -8
  2. package/package.json +1 -1
  3. package/src/bin/namecheap.js +0 -0
package/README.md CHANGED
@@ -8,29 +8,54 @@ Command-line interface for [Namecheap](https://www.namecheap.com) domain, DNS, a
8
8
  npm install -g @fredlackey/cli-namecheap
9
9
  ```
10
10
 
11
- ## Configure
11
+ ## Usage
12
+
13
+ Every command accepts credentials directly as flags. No setup step is required.
12
14
 
13
15
  ```
14
- namecheap configure \
16
+ namecheap domain list \
15
17
  --api-user flackey \
16
18
  --api-key <key> \
17
19
  --client-ip 203.0.113.42
18
- ```
19
20
 
20
- Running `namecheap configure` without flags prompts for each value interactively. Credentials are stored in `~/.config/cli-namecheap/config.json` and that file is the only config source. There are no environment variables to set.
21
-
22
- Your client IP must be whitelisted in the Namecheap dashboard at `https://ap.www.namecheap.com/settings/tools/apiaccess/` before any API calls will succeed.
21
+ namecheap dns list --name example.com \
22
+ --api-user flackey \
23
+ --api-key <key> \
24
+ --client-ip 203.0.113.42
25
+ ```
23
26
 
24
- ## Usage
27
+ If you've already run `namecheap configure`, you can omit the credential flags:
25
28
 
26
29
  ```
27
30
  namecheap domain list
28
31
  namecheap domain check --name coolstartup.com,coolstartup.io
29
- namecheap dns list --name example.com
30
32
  namecheap dns set-custom --name example.com --ns ns1.cloudflare.com,ns2.cloudflare.com
31
33
  namecheap domain catalog --concurrency 5
32
34
  ```
33
35
 
36
+ Your client IP must be whitelisted in the Namecheap dashboard at `https://ap.www.namecheap.com/settings/tools/apiaccess/` before any API calls will succeed.
37
+
38
+ ## Configure (Optional)
39
+
40
+ **The `configure` command is optional.** Every command accepts credentials directly as flags (e.g. `--api-key`, `--api-user`). You never need to run `configure` to use this tool. It exists as a convenience so you don't have to pass the same flags on every invocation.
41
+
42
+ ```
43
+ namecheap configure \
44
+ --api-user flackey \
45
+ --api-key <key> \
46
+ --client-ip 203.0.113.42
47
+ ```
48
+
49
+ Running `namecheap configure` without flags prompts for each value interactively. Credentials are stored in `~/.config/cli-namecheap/config.json` and that file is the only config source. There are no environment variables to set.
50
+
51
+ If a required credential is missing at runtime, the error tells you exactly what to do:
52
+
53
+ ```json
54
+ {
55
+ "error": "Missing required value: --api-key. Pass it as a flag or run \"namecheap configure\"."
56
+ }
57
+ ```
58
+
34
59
  ## Full Command Reference
35
60
 
36
61
  For the complete list of commands and flags, see [COMMANDS.md](COMMANDS.md).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fredlackey/cli-namecheap",
3
- "version": "0.0.1",
3
+ "version": "0.0.3",
4
4
  "description": "AI-first CLI for Namecheap domain, DNS, and SSL management",
5
5
  "author": {
6
6
  "name": "Fred Lackey",
package/src/bin/namecheap.js CHANGED
File without changes