@bitsocial/bitsocial-cli 0.19.39 → 0.19.41

package/oclif.manifest.json

@@ -0,0 +1,707 @@
+{
+  "commands": {
+    "daemon": {
+      "aliases": [],
+      "args": {},
+      "description": "Run a network-connected Bitsocial node. Once the daemon is running you can create and start your communities and receive publications from users. The daemon will also serve web ui on http that can be accessed through a browser on any machine. Within the web ui users are able to browse, create and manage their communities fully P2P.\n    Options can be passed to the RPC's instance through flag --pkcOptions.optionName. For a list of pkc options (https://github.com/pkcprotocol/pkc-js?tab=readme-ov-file#pkcoptions)\n    If you need to modify ipfs config, you should head to {bitsocial-data-path}/.ipfs-bitsocial-cli/config and modify the config file\n    ",
+      "examples": [
+        "bitsocial daemon",
+        "bitsocial daemon --pkcRpcUrl ws://localhost:53812",
+        "bitsocial daemon --pkcOptions.dataPath /tmp/bitsocial-datapath/",
+        "bitsocial daemon --pkcOptions.kuboRpcClientsOptions[0] https://remoteipfsnode.com",
+        "bitsocial daemon --chainProviderUrls https://mainnet.infura.io/v3/YOUR_KEY",
+        "bitsocial daemon --chainProviderUrls viem --chainProviderUrls https://mainnet.infura.io/v3/YOUR_KEY"
+      ],
+      "flags": {
+        "pkcRpcUrl": {
+          "description": "Specify PKC RPC URL to listen on",
+          "name": "pkcRpcUrl",
+          "required": true,
+          "default": "ws://localhost:9138/",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "logPath": {
+          "description": "Specify a directory which will be used to store logs",
+          "name": "logPath",
+          "required": true,
+          "default": "/home/runner/.local/state/bitsocial",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "chainProviderUrls": {
+          "description": "Ethereum RPC URL(s) for .bso/.eth name resolution. Can be specified multiple times. Defaults to viem public transport and https://ethrpc.xyz",
+          "name": "chainProviderUrls",
+          "default": [
+            "viem",
+            "https://ethrpc.xyz"
+          ],
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "daemon",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "daemon.js"
+      ]
+    },
+    "logs": {
+      "aliases": [],
+      "args": {},
+      "description": "View the latest BitSocial daemon log file. By default dumps the full log and exits. Use --follow to stream new output in real-time (like tail -f).",
+      "examples": [
+        "bitsocial logs",
+        "bitsocial logs -f",
+        "bitsocial logs -n 50",
+        "bitsocial logs --since 5m",
+        "bitsocial logs --since 2026-01-02T13:23:37Z --until 2026-01-02T14:00:00Z",
+        "bitsocial logs --since 1h -f"
+      ],
+      "flags": {
+        "follow": {
+          "char": "f",
+          "description": "Follow log output in real-time (like tail -f)",
+          "name": "follow",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "tail": {
+          "char": "n",
+          "description": "Number of log entries to show from the end. Use \"all\" to show everything.",
+          "name": "tail",
+          "default": "all",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "since": {
+          "description": "Show logs since timestamp (ISO 8601, e.g. 2026-01-02T13:23:37Z) or relative time (e.g. 30s, 42m, 2h, 1d)",
+          "name": "since",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "until": {
+          "description": "Show logs before timestamp (ISO 8601, e.g. 2026-01-02T13:23:37Z) or relative time (e.g. 30s, 42m, 2h, 1d)",
+          "name": "until",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "logPath": {
+          "description": "Specify the directory containing log files",
+          "name": "logPath",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "logs",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "logs.js"
+      ]
+    },
+    "challenge:install": {
+      "aliases": [],
+      "args": {
+        "package": {
+          "description": "Package specifier — anything npm can install (name, name@version, git URL, tarball URL, local path)",
+          "name": "package",
+          "required": true
+        }
+      },
+      "description": "Install a challenge package (npm package name, git URL, tarball URL, or local path)",
+      "examples": [
+        "bitsocial challenge install @bitsocial/mintpass-challenge",
+        "bitsocial challenge install @bitsocial/mintpass-challenge@1.0.0",
+        "bitsocial challenge install github:user/repo",
+        "bitsocial challenge install https://example.com/my-challenge-1.0.0.tar.gz",
+        "bitsocial challenge install ./my-local-challenge"
+      ],
+      "flags": {
+        "pkcOptions.dataPath": {
+          "description": "Data path to install the challenge into",
+          "name": "pkcOptions.dataPath",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "challenge:install",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "challenge",
+        "install.js"
+      ]
+    },
+    "challenge:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List installed challenge packages",
+      "examples": [
+        "bitsocial challenge list",
+        "bitsocial challenge list -q"
+      ],
+      "flags": {
+        "quiet": {
+          "char": "q",
+          "name": "quiet",
+          "summary": "Only display challenge names",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "pkcOptions.dataPath": {
+          "description": "Data path where challenges are installed",
+          "name": "pkcOptions.dataPath",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "challenge:list",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "challenge",
+        "list.js"
+      ]
+    },
+    "challenge:remove": {
+      "aliases": [],
+      "args": {
+        "name": {
+          "description": "The challenge package name (e.g., my-challenge or @scope/my-challenge)",
+          "name": "name",
+          "required": true
+        }
+      },
+      "description": "Remove an installed challenge package",
+      "examples": [
+        "bitsocial challenge remove my-challenge",
+        "bitsocial challenge remove @scope/my-challenge"
+      ],
+      "flags": {
+        "pkcOptions.dataPath": {
+          "description": "Data path where challenges are installed",
+          "name": "pkcOptions.dataPath",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "challenge:remove",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "challenge",
+        "remove.js"
+      ]
+    },
+    "community:create": {
+      "aliases": [],
+      "args": {},
+      "description": "Create a community with specific properties. A newly created community will be started after creation and be able to receive publications. For a list of properties, visit https://github.com/pkcprotocol/pkc-js",
+      "examples": [
+        {
+          "description": "Create a community with title 'Hello Plebs' and description 'Welcome'",
+          "command": "<%= config.bin %> <%= command.id %> --title 'Hello Plebs' --description 'Welcome'"
+        }
+      ],
+      "flags": {
+        "pkcRpcUrl": {
+          "name": "pkcRpcUrl",
+          "required": true,
+          "summary": "URL to PKC RPC",
+          "default": "ws://localhost:9138/",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "privateKeyPath": {
+          "description": "Private key (PEM) of the community signer that will be used to determine address (if address is not a domain). If it's not provided then PKC will generate a private key",
+          "name": "privateKeyPath",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "community:create",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "community",
+        "create.js"
+      ]
+    },
+    "community:delete": {
+      "aliases": [],
+      "args": {
+        "addresses": {
+          "description": "Addresses of communities to delete. Separated by space",
+          "name": "addresses",
+          "required": true
+        }
+      },
+      "description": "Delete a community permanently.",
+      "examples": [
+        "bitsocial community delete plebbit.bso",
+        "bitsocial community delete 12D3KooWG3XbzoVyAE6Y9vHZKF64Yuuu4TjdgQKedk14iYmTEPWu"
+      ],
+      "flags": {
+        "pkcRpcUrl": {
+          "name": "pkcRpcUrl",
+          "required": true,
+          "summary": "URL to PKC RPC",
+          "default": "ws://localhost:9138/",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "community:delete",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "community",
+        "delete.js"
+      ]
+    },
+    "community:edit": {
+      "aliases": [],
+      "args": {
+        "address": {
+          "description": "Address of the community to edit",
+          "name": "address",
+          "required": true
+        }
+      },
+      "description": "Edit a community's properties. For a list of properties, visit https://github.com/pkcprotocol/pkc-js",
+      "examples": [
+        {
+          "description": "Change the address of the community to a new domain address",
+          "command": "bitsocial community edit 12D3KooWG3XbzoVyAE6Y9vHZKF64Yuuu4TjdgQKedk14iYmTEPWu --address newAddress.bso"
+        },
+        {
+          "description": "Add the author address 'esteban.bso' as an admin on the community",
+          "command": "bitsocial community edit mysub.bso '--roles[\"esteban.bso\"].role' admin"
+        },
+        {
+          "description": "Add two challenges to the community. The first challenge will be a question and answer, and the second will be an image captcha",
+          "command": "bitsocial community edit mysub.bso --settings.challenges[0].name question --settings.challenges[0].options.question \"what is the password?\" --settings.challenges[0].options.answer thepassword --settings.challenges[1].name captcha-canvas-v3"
+        },
+        {
+          "description": "Change the title and description",
+          "command": "bitsocial community edit mysub.bso --title \"This is the new title\" --description \"This is the new description\" "
+        },
+        {
+          "description": "Remove a role from a moderator/admin/owner",
+          "command": "bitsocial community edit plebbit.bso --roles['rinse12.bso'] null"
+        },
+        {
+          "description": "Enable settings.fetchThumbnailUrls to fetch the thumbnail of url submitted by authors",
+          "command": "bitsocial community edit plebbit.bso --settings.fetchThumbnailUrls"
+        },
+        {
+          "description": "disable settings.fetchThumbnailUrls",
+          "command": "bitsocial community edit plebbit.bso --settings.fetchThumbnailUrls=false"
+        }
+      ],
+      "flags": {
+        "pkcRpcUrl": {
+          "name": "pkcRpcUrl",
+          "required": true,
+          "summary": "URL to PKC RPC",
+          "default": "ws://localhost:9138/",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "community:edit",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "community",
+        "edit.js"
+      ]
+    },
+    "community:get": {
+      "aliases": [],
+      "args": {
+        "address": {
+          "description": "Address of the community to fetch",
+          "name": "address",
+          "required": false
+        }
+      },
+      "description": "Fetch a local or remote community, and print its json in the terminal",
+      "examples": [
+        "bitsocial community get plebmusic.bso",
+        "bitsocial community get 12D3KooWG3XbzoVyAE6Y9vHZKF64Yuuu4TjdgQKedk14iYmTEPWu",
+        "bitsocial community get --name my-community",
+        "bitsocial community get --publicKey 12D3KooWG3XbzoVyAE6Y9vHZKF64Yuuu4TjdgQKedk14iYmTEPWu"
+      ],
+      "flags": {
+        "pkcRpcUrl": {
+          "name": "pkcRpcUrl",
+          "required": true,
+          "summary": "URL to PKC RPC",
+          "default": "ws://localhost:9138/",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "name": {
+          "description": "Name of the community to fetch",
+          "name": "name",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "publicKey": {
+          "description": "Public key of the community to fetch",
+          "name": "publicKey",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "community:get",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "community",
+        "get.js"
+      ]
+    },
+    "community:list": {
+      "aliases": [],
+      "args": {},
+      "description": "List your communities",
+      "examples": [
+        "bitsocial community list -q",
+        "bitsocial community list"
+      ],
+      "flags": {
+        "pkcRpcUrl": {
+          "name": "pkcRpcUrl",
+          "required": true,
+          "summary": "URL to PKC RPC",
+          "default": "ws://localhost:9138/",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "quiet": {
+          "char": "q",
+          "name": "quiet",
+          "summary": "Only display community addresses",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "community:list",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "community",
+        "list.js"
+      ]
+    },
+    "community:start": {
+      "aliases": [],
+      "args": {
+        "addresses": {
+          "description": "Addresses of communities to start. Separated by space",
+          "name": "addresses",
+          "required": true
+        }
+      },
+      "description": "Start a community",
+      "examples": [
+        "bitsocial community start plebbit.bso",
+        "bitsocial community start 12D3KooWG3XbzoVyAE6Y9vHZKF64Yuuu4TjdgQKedk14iYmTEPWu",
+        {
+          "description": "Start all communities in your data path",
+          "command": "bitsocial community start $(bitsocial community list -q)"
+        }
+      ],
+      "flags": {
+        "pkcRpcUrl": {
+          "name": "pkcRpcUrl",
+          "required": true,
+          "summary": "URL to PKC RPC",
+          "default": "ws://localhost:9138/",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "community:start",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "community",
+        "start.js"
+      ]
+    },
+    "community:stop": {
+      "aliases": [],
+      "args": {
+        "addresses": {
+          "description": "Addresses of communities to stop. Separated by space",
+          "name": "addresses",
+          "required": true
+        }
+      },
+      "description": "Stop a community. The community will not publish or receive any publications until it is started again.",
+      "examples": [
+        "bitsocial community stop plebbit.bso",
+        "bitsocial community stop Qmb99crTbSUfKXamXwZBe829Vf6w5w5TktPkb6WstC9RFW"
+      ],
+      "flags": {
+        "pkcRpcUrl": {
+          "name": "pkcRpcUrl",
+          "required": true,
+          "summary": "URL to PKC RPC",
+          "default": "ws://localhost:9138/",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "community:stop",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": false,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "community",
+        "stop.js"
+      ]
+    },
+    "update:check": {
+      "aliases": [],
+      "args": {},
+      "description": "Check if a newer version of bitsocial is available on npm",
+      "examples": [
+        "bitsocial update check"
+      ],
+      "flags": {},
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "update:check",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "update",
+        "check.js"
+      ]
+    },
+    "update:install": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "default": "latest",
+          "description": "Version to install (e.g. \"0.19.40\" or \"latest\")",
+          "name": "version",
+          "required": false
+        }
+      },
+      "description": "Install a specific version of bitsocial from npm",
+      "examples": [
+        "bitsocial update install",
+        "bitsocial update install latest",
+        "bitsocial update install 0.19.40",
+        "bitsocial update install --force"
+      ],
+      "flags": {
+        "force": {
+          "description": "Reinstall even if already on the requested version",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "update:install",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "update",
+        "install.js"
+      ]
+    },
+    "update:versions": {
+      "aliases": [],
+      "args": {},
+      "description": "List available bitsocial versions on npm",
+      "examples": [
+        "bitsocial update versions",
+        "bitsocial update versions --limit 5"
+      ],
+      "flags": {
+        "limit": {
+          "description": "Maximum number of versions to display",
+          "name": "limit",
+          "default": 20,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "update:versions",
+      "pluginAlias": "@bitsocial/bitsocial-cli",
+      "pluginName": "@bitsocial/bitsocial-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "cli",
+        "commands",
+        "update",
+        "versions.js"
+      ]
+    }
+  },
+  "version": "0.19.41"
+}