@offckb/cli 0.1.0-rc2 → 0.1.0-rc3

package/README.md

@@ -5,24 +5,46 @@ ckb development environment for professionals
 ## Install
 
 ```sh
-git clone https://github.com/RetricSu/offckb.git
-cd offckb && alias offckb='yarn start'
-```
-
-eventually you will do simple
-```sh
-npm install -g offckb // not yet, todo
+npm install -g @offckb/cli
 ```
 
 ## Usage
 
 ```sh
 offckb node // start the devnet of CKB 
-offckb init // init a typescript boilerplate with lumos to get started with to build CKB DAPP,think 'hardhat init'
-offckb list-hashes // list scripts hashes, equals `ckb list-hashes`
+offckb init <project-name> // init a typescript boilerplate with lumos to get started with to build CKB DAPP,think 'hardhat init'
 offckb accounts // list 20 accounts info with prefund CKB tokens
+offckb list-hashes // list scripts hashes, equals `ckb list-hashes`
+```
+
+### Get started
+
+```sh
+offckb init my-awesome-ckb-dapp
+cd my-awesome-ckb-dapp
+yarn && yarn start
+
+## results
+yarn run v1.22.19
+$ parcel index.html
+Server running at http://localhost:1234
+✨ Built in 10ms
 ```
 
+open another terminal and start the devnet:
+
+```sh
+offckb node
+```
+
+open another terminal and check the accounts to use:
+
+```sh
+offckb accounts
+```
+
+Copy some private keys and visit http://localhost:1234 to play basic CKB transfer!
+
 ### Built-in scripts
 
 - [x] xUDT https://github.com/nervosnetwork/rfcs/pull/428

package/dist/cli.js

@@ -16,11 +16,20 @@ program
     .name('offckb')
     .description('CLI to provide full ckb development environment for professionals')
     .version(version);
+program
+    .command('init')
+    .description('init dapp project with lumos')
+    .argument('<string>', 'name of the dapp')
+    .action((str) => {
+    const name = str !== null && str !== void 0 ? str : 'offckb-dapp';
+    return (0, init_1.init)(name);
+});
+program.command('node').description('Use the CKB to start devnet').action(node_1.node);
+program.command('accounts').description('print account list info').action(accounts_1.accounts);
+program.command('list-hashes').description('Use the CKB to list blockchain scripts hashes').action(list_hashes_1.listHashes);
 // Define the CLI commands and options
 program.command('install').description('Install the ckb dependency binary').action(install_1.installDependency);
 program.command('genkey').description('generate 20 accounts').action(genkey_1.genkey);
-program.command('list-hashes').description('Use the CKB to list blockchain scripts hashes').action(list_hashes_1.listHashes);
-program.command('node').description('Use the CKB to start devnet').action(node_1.node);
 program.command('init-chain').description('Use the CKB to init devnet').action(init_chain_1.initChainIfNeeded);
 program.command('build-lumos-config').description('Use the CKB to generate lumos config.json').action(build_lumos_config_1.buildLumosConfig);
 program.command('build-accounts').description('generate accounts with prefunded CKB tokens').action(genkey_1.buildAccounts);
@@ -28,15 +37,6 @@ program
     .command('print-account-issue-info')
     .description('print account issue cells config toml sections')
     .action(genkey_1.printIssueSectionForToml);
-program.command('accounts').description('print account list info').action(accounts_1.accounts);
-program
-    .command('init')
-    .description('init dapp project with lumos')
-    .argument('<string>', 'name of the dapp')
-    .action((str) => {
-    const name = str !== null && str !== void 0 ? str : 'offckb-dapp';
-    return (0, init_1.init)(name);
-});
 // Parse command-line arguments
 program.parse(process.argv);
 // If no command is specified, display help

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offckb/cli",
-  "version": "0.1.0-rc2",
+  "version": "0.1.0-rc3",
   "description": "ckb development environment for professionals",
   "author": "Retric Su <retric@cryptape.com>",
   "license": "MIT",