|
| 1 | +oclif-hello-world |
| 2 | +================= |
| 3 | + |
| 4 | +oclif example Hello World CLI |
| 5 | + |
| 6 | +[](https://oclif.io) |
| 7 | +[](https://npmjs.org/package/oclif-hello-world) |
| 8 | +[](https://circleci.com/gh/oclif/hello-world/tree/main) |
| 9 | +[](https://npmjs.org/package/oclif-hello-world) |
| 10 | +[](https://github.com/oclif/hello-world/blob/main/package.json) |
| 11 | + |
| 12 | +<!-- toc --> |
| 13 | +* [Usage](#usage) |
| 14 | +* [Commands](#commands) |
| 15 | +<!-- tocstop --> |
| 16 | +# Usage |
| 17 | +<!-- usage --> |
| 18 | +```sh-session |
| 19 | +$ npm install -g oclif-hello-world |
| 20 | +$ oex COMMAND |
| 21 | +running command... |
| 22 | +$ oex (--version) |
| 23 | +oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1 |
| 24 | +$ oex --help [COMMAND] |
| 25 | +USAGE |
| 26 | + $ oex COMMAND |
| 27 | +... |
| 28 | +``` |
| 29 | +<!-- usagestop --> |
| 30 | +# Commands |
| 31 | +<!-- commands --> |
| 32 | +* [`oex hello PERSON`](#oex-hello-person) |
| 33 | +* [`oex hello world`](#oex-hello-world) |
| 34 | +* [`oex help [COMMAND]`](#oex-help-command) |
| 35 | +* [`oex plugins`](#oex-plugins) |
| 36 | +* [`oex plugins:inspect PLUGIN...`](#oex-pluginsinspect-plugin) |
| 37 | +* [`oex plugins:install PLUGIN...`](#oex-pluginsinstall-plugin) |
| 38 | +* [`oex plugins:link PLUGIN`](#oex-pluginslink-plugin) |
| 39 | +* [`oex plugins:uninstall PLUGIN...`](#oex-pluginsuninstall-plugin) |
| 40 | +* [`oex plugins update`](#oex-plugins-update) |
| 41 | + |
| 42 | +## `oex hello PERSON` |
| 43 | + |
| 44 | +Say hello |
| 45 | + |
| 46 | +``` |
| 47 | +USAGE |
| 48 | + $ oex hello [PERSON] -f <value> |
| 49 | +
|
| 50 | +ARGUMENTS |
| 51 | + PERSON Person to say hello to |
| 52 | +
|
| 53 | +FLAGS |
| 54 | + -f, --from=<value> (required) Whom is saying hello |
| 55 | +
|
| 56 | +DESCRIPTION |
| 57 | + Say hello |
| 58 | +
|
| 59 | +EXAMPLES |
| 60 | + $ oex hello friend --from oclif |
| 61 | + hello friend from oclif! (./src/commands/hello/index.ts) |
| 62 | +``` |
| 63 | + |
| 64 | +_See code: [dist/commands/hello/index.ts](https://github.com/oclif/hello-world/blob/v0.0.0/dist/commands/hello/index.ts)_ |
| 65 | + |
| 66 | +## `oex hello world` |
| 67 | + |
| 68 | +Say hello world |
| 69 | + |
| 70 | +``` |
| 71 | +USAGE |
| 72 | + $ oex hello world |
| 73 | +
|
| 74 | +DESCRIPTION |
| 75 | + Say hello world |
| 76 | +
|
| 77 | +EXAMPLES |
| 78 | + $ oex hello world |
| 79 | + hello world! (./src/commands/hello/world.ts) |
| 80 | +``` |
| 81 | + |
| 82 | +## `oex help [COMMAND]` |
| 83 | + |
| 84 | +Display help for oex. |
| 85 | + |
| 86 | +``` |
| 87 | +USAGE |
| 88 | + $ oex help [COMMAND] [-n] |
| 89 | +
|
| 90 | +ARGUMENTS |
| 91 | + COMMAND Command to show help for. |
| 92 | +
|
| 93 | +FLAGS |
| 94 | + -n, --nested-commands Include all nested commands in the output. |
| 95 | +
|
| 96 | +DESCRIPTION |
| 97 | + Display help for oex. |
| 98 | +``` |
| 99 | + |
| 100 | +_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_ |
| 101 | + |
| 102 | +## `oex plugins` |
| 103 | + |
| 104 | +List installed plugins. |
| 105 | + |
| 106 | +``` |
| 107 | +USAGE |
| 108 | + $ oex plugins [--core] |
| 109 | +
|
| 110 | +FLAGS |
| 111 | + --core Show core plugins. |
| 112 | +
|
| 113 | +DESCRIPTION |
| 114 | + List installed plugins. |
| 115 | +
|
| 116 | +EXAMPLES |
| 117 | + $ oex plugins |
| 118 | +``` |
| 119 | + |
| 120 | +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_ |
| 121 | + |
| 122 | +## `oex plugins:inspect PLUGIN...` |
| 123 | + |
| 124 | +Displays installation properties of a plugin. |
| 125 | + |
| 126 | +``` |
| 127 | +USAGE |
| 128 | + $ oex plugins:inspect PLUGIN... |
| 129 | +
|
| 130 | +ARGUMENTS |
| 131 | + PLUGIN [default: .] Plugin to inspect. |
| 132 | +
|
| 133 | +FLAGS |
| 134 | + -h, --help Show CLI help. |
| 135 | + -v, --verbose |
| 136 | +
|
| 137 | +DESCRIPTION |
| 138 | + Displays installation properties of a plugin. |
| 139 | +
|
| 140 | +EXAMPLES |
| 141 | + $ oex plugins:inspect myplugin |
| 142 | +``` |
| 143 | + |
| 144 | +## `oex plugins:install PLUGIN...` |
| 145 | + |
| 146 | +Installs a plugin into the CLI. |
| 147 | + |
| 148 | +``` |
| 149 | +USAGE |
| 150 | + $ oex plugins:install PLUGIN... |
| 151 | +
|
| 152 | +ARGUMENTS |
| 153 | + PLUGIN Plugin to install. |
| 154 | +
|
| 155 | +FLAGS |
| 156 | + -f, --force Run yarn install with force flag. |
| 157 | + -h, --help Show CLI help. |
| 158 | + -v, --verbose |
| 159 | +
|
| 160 | +DESCRIPTION |
| 161 | + Installs a plugin into the CLI. |
| 162 | +
|
| 163 | + Can be installed from npm or a git url. |
| 164 | +
|
| 165 | + Installation of a user-installed plugin will override a core plugin. |
| 166 | +
|
| 167 | + e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command |
| 168 | + will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in |
| 169 | + the CLI without the need to patch and update the whole CLI. |
| 170 | +
|
| 171 | +ALIASES |
| 172 | + $ oex plugins add |
| 173 | +
|
| 174 | +EXAMPLES |
| 175 | + $ oex plugins:install myplugin |
| 176 | +
|
| 177 | + $ oex plugins:install https://github.com/someuser/someplugin |
| 178 | +
|
| 179 | + $ oex plugins:install someuser/someplugin |
| 180 | +``` |
| 181 | + |
| 182 | +## `oex plugins:link PLUGIN` |
| 183 | + |
| 184 | +Links a plugin into the CLI for development. |
| 185 | + |
| 186 | +``` |
| 187 | +USAGE |
| 188 | + $ oex plugins:link PLUGIN |
| 189 | +
|
| 190 | +ARGUMENTS |
| 191 | + PATH [default: .] path to plugin |
| 192 | +
|
| 193 | +FLAGS |
| 194 | + -h, --help Show CLI help. |
| 195 | + -v, --verbose |
| 196 | +
|
| 197 | +DESCRIPTION |
| 198 | + Links a plugin into the CLI for development. |
| 199 | +
|
| 200 | + Installation of a linked plugin will override a user-installed or core plugin. |
| 201 | +
|
| 202 | + e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' |
| 203 | + command will override the user-installed or core plugin implementation. This is useful for development work. |
| 204 | +
|
| 205 | +EXAMPLES |
| 206 | + $ oex plugins:link myplugin |
| 207 | +``` |
| 208 | + |
| 209 | +## `oex plugins:uninstall PLUGIN...` |
| 210 | + |
| 211 | +Removes a plugin from the CLI. |
| 212 | + |
| 213 | +``` |
| 214 | +USAGE |
| 215 | + $ oex plugins:uninstall PLUGIN... |
| 216 | +
|
| 217 | +ARGUMENTS |
| 218 | + PLUGIN plugin to uninstall |
| 219 | +
|
| 220 | +FLAGS |
| 221 | + -h, --help Show CLI help. |
| 222 | + -v, --verbose |
| 223 | +
|
| 224 | +DESCRIPTION |
| 225 | + Removes a plugin from the CLI. |
| 226 | +
|
| 227 | +ALIASES |
| 228 | + $ oex plugins unlink |
| 229 | + $ oex plugins remove |
| 230 | +``` |
| 231 | + |
| 232 | +## `oex plugins update` |
| 233 | + |
| 234 | +Update installed plugins. |
| 235 | + |
| 236 | +``` |
| 237 | +USAGE |
| 238 | + $ oex plugins update [-h] [-v] |
| 239 | +
|
| 240 | +FLAGS |
| 241 | + -h, --help Show CLI help. |
| 242 | + -v, --verbose |
| 243 | +
|
| 244 | +DESCRIPTION |
| 245 | + Update installed plugins. |
| 246 | +``` |
| 247 | +<!-- commandsstop --> |
| 248 | + |
| 249 | +## CSLI |
| 250 | + |
| 251 | +### `wasmd` |
| 252 | + |
| 253 | +If you wish, you may download the `wasmd` binary using an Intel chip on a modern Macbook Pro. |
| 254 | + |
| 255 | +The location is IPFS hash: |
| 256 | + |
| 257 | + bafybeiaqdtgvv5gqn7wymurtfmaotokn4de6dtnyooa4fu7hxnvdw3au4y |
| 258 | + |
| 259 | +The [Fleek](https://fleek.co) gateway link to download it: |
| 260 | + |
| 261 | +https://storageapi.fleek.co/0f8bb5c1-0de9-47f6-ac16-ffbd010540c0-bucket/wasmd |
0 commit comments