@beclab/olaresid 0.1.12 → 0.2.0

package/CLI-TREE.md

@@ -0,0 +1,107 @@
+# OlaresID CLI Command Reference
+
+Command: `did-cli`  
+Install: `npm install -g @beclab/olaresid`
+
+For scenario-based usage examples, see [CLI.md](./CLI.md).
+
+> **Signer for write operations:** `export PRIVATE_KEY_OR_MNEMONIC="your-key-or-mnemonic"`  
+> **Olares ID format:** `alice@olares.com` and `alice.olares.com` are interchangeable in all commands.
+
+```
+did-cli
+│
+├── Query                                           [🌐 Public]
+│   ├── info <domain>                               metadata: name / DID / owner / allowSubdomain
+│   ├── owner <domain>                              NFT owner address
+│   ├── fetch <domain>                              full domain data including all tags
+│   └── fetch-all [--output <file>]                 download all domains to JSON
+│
+├── RSA key
+│   ├── rsa get <domain>                            [🌐 Public]   PEM public key
+│   ├── rsa generate [--key-length <bits>] [-o]     [🌐 Local]    generate RSA key pair
+│   ├── rsa set <domain> <pem-file>                 [🔑 Domain Owner]
+│   └── rsa remove <domain>                         [🔑 Domain Owner]
+│
+├── IP
+│   ├── ip get <domain>                             [🌐 Public]   DNS A record (IPv4)
+│   ├── ip set <domain> <ipv4>                      [🔑 Domain Owner]
+│   └── ip remove <domain>                          [🔑 Domain Owner]
+│
+├── Wallet
+│   ├── wallet evm list <domain>                    [🌐 Public]
+│   ├── wallet solana list <domain>                 [🌐 Public]
+│   ├── wallet evm add <domain>         [🔑 Domain Owner]  env: EVM_PRIVATE_KEY
+│   ├── wallet evm remove <domain>      [🔑 Domain Owner]  env: EVM_PRIVATE_KEY
+│   ├── wallet solana add <domain>      [🔑 Domain Owner]  env: SOLANA_PRIVATE_KEY
+│   └── wallet solana remove <domain>   [🔑 Domain Owner]  env: SOLANA_PRIVATE_KEY
+│
+├── Domain operations                               [🔑 Domain Owner]
+│   ├── is-owner <domain>                           check if signer owns the domain
+│   ├── subdomain register <parent> <label>         env: SUBDOMAIN_OWNER_MNEMONIC (auto-gen if unset)
+│   └── transfer <domain>                           env: TO_MNEMONIC (auto-gen if unset)
+│
+├── Tag                                             [--from <domain|root>  default: target domain]
+│   ├── tag get <domain> <tag-name>                 [🌐 Public]
+│   ├── tag list <domain>                           [🌐 Public]   all tag values on domain
+│   ├── tag list-defined [<domain>]                 [🌐 Public]   tag types defined by domain
+│   ├── tag get-tagger <domain> <tag-name>          [🌐 Public]
+│   ├── tag define <domain> <tag-name> <type>       [🔑 Domain Owner]
+│   │   └── types: string / uint8 / uint256 / int8 / int256 / bool / address / bytes / bytes32
+│   │             string[] / uint8[] / address[] / ...
+│   ├── tag set-tagger <domain> <tag-name> <addr>   [🔑 Domain Owner]
+│   ├── tag set <domain> <tag-name> <value>         [🔑 Domain Owner]   value: string or JSON
+│   └── tag remove <domain> <tag-name>              [🔑 Domain Owner]
+│
+├── Admin
+│   ├── admin get-owner                             [🌐 Public]
+│   ├── admin get-totalsupply                       [🌐 Public]
+│   ├── admin get-operator                          [🌐 Public]
+│   ├── admin set-operator <address>                [👑 Contract Owner]
+│   ├── admin transfer-ownership <address>          [👑 Contract Owner]  2-step: initiate
+│   └── admin accept-ownership                      [👑 Contract Owner]  2-step: confirm
+│
+├── crypto / convert                                [🌐 Local — no network]
+│   ├── crypto generate [--words <n>] [-o <file>]   generate BIP39 mnemonic
+│   ├── crypto address                              derive Ethereum address
+│   ├── crypto did                                  derive DID from mnemonic
+│   ├── crypto privatekey [-o <file>]               derive EVM private key
+│   ├── crypto derive [-o <file>]                   derive all keys from mnemonic
+│   ├── convert pem-to-der <file>                   PEM → DER hex
+│   ├── convert der-to-pem <hex>                    DER hex → PEM
+│   ├── convert ip-to-bytes <ip>                    IPv4 → bytes4
+│   └── convert bytes-to-ip <hex>                   bytes4 → IPv4
+│
+└── config                                          [🌐 Local config file]
+    ├── config show [--network <network>]
+    ├── config list
+    └── config set <key> <value> [--network <network>]
+        └── keys: rpc / contractDid / contractRootResolver / contractAbiType
+                  contractRootResolver2 / supportSvcUrl / queryContract
+```
+
+---
+
+```
+Global options
+  -n, --network <network>         mainnet (default) | sepolia
+      --from <domain|root>        tag source domain (tag commands)
+      --rpc <url>                 override RPC endpoint
+      --contract-did <addr>       override DID contract
+      --contract-resolver <addr>  override RootResolver contract
+      --contract-resolver2 <addr> override RootResolver2 contract
+  -j, --json                      machine-readable JSON output
+  -v, --verbose                   verbose debug output
+  -o, --output <file>             output file path
+      --key-length <bits>         RSA key length (default 2048)
+  -h, --help
+  -V, --version
+
+Permission legend
+  🌐 Public        no signing required
+  🔑 Domain Owner  holder of the domain NFT
+  👑 Contract Owner  Ownable2Step super-admin
+
+⚠️  Operator role: exists at the contract level for registering root domains;
+    not exposed as a CLI command.
+```