Merge pull request #24 from casper-network/publish/initial-version

Release 1.0 version
casper-network · Jul 12, 2023 · fef7b9a · fef7b9a
2 parents bf68ddf + c97788d
commit fef7b9a
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 288 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to casper-js-sdk.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!--
+  Please follow below structures.
+  ## [1.1.1] - 2023-03-05
+  ### Added
+  ### Fixed
+  ### Changed
+  ### Removed
+ -->
+
+## [Unreleased]
+
+## [0.0.1] - 2023-7-12
+
+Initial version of `casper-node-launcher-js`.
+
+### Added
+
+- Started to use CHANGELOG.
+
+[0.0.1]: https://github.com/casper-network/casper-node-launcher-js/compare/0.0.1...main
diff --git a/README.md b/README.md
@@ -1,306 +1,48 @@
 # casper-node-launcher-js
 
-The npm library for makes easy to run casper node for test purpose.
+The npm library makes easy to run casper node for test purpose.
 
 > Only Linux supported currently
 
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
-[![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/gyroflaw/casper-node-launcher/blob/main/package.json)
+[![Version](https://img.shields.io/npm/v/casper-node-launcher-js.svg)](https://npmjs.org/package/casper-node-launcher-js)
+[![License](https://img.shields.io/npm/l/casper-node-launcher-js.svg)](https://github.com/casper-network/casper-node-launcher/blob/main/package.json)
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
 
-<!-- toc -->
+## Usage
 
-- [casper-node-launcher-js](#casper-node-launcher-js)
-- [Usage](#usage)
-- [Commands](#commands)
-<!-- tocstop -->
+- Install library
 
-# Usage
+  ```sh
+  npm install -g casper-node-launcher-js
+  ```
 
-<!-- usage -->
+- Run a single node (from the lastest release)
 
-```sh-session
-$ npm install -g casper-node-launcher-js
-$ casper-node-launcher-js COMMAND
-running command...
-$ casper-node-launcher-js (--version)
-casper-node-launcher-js/0.0.2 linux-x64 node-v16.15.1
-$ casper-node-launcher-js --help [COMMAND]
-USAGE
-  $ casper-node-launcher-js COMMAND
-...
-```
-
-<!-- usagestop -->
-
-# Commands
-
-<!-- commands -->
-
-- [`casper-node-launcher-js help [COMMANDS]`](#casper-node-launcher-js-help-commands)
-- [`casper-node-launcher-js plugins`](#casper-node-launcher-js-plugins)
-- [`casper-node-launcher-js plugins:install PLUGIN...`](#casper-node-launcher-js-pluginsinstall-plugin)
-- [`casper-node-launcher-js plugins:inspect PLUGIN...`](#casper-node-launcher-js-pluginsinspect-plugin)
-- [`casper-node-launcher-js plugins:install PLUGIN...`](#casper-node-launcher-js-pluginsinstall-plugin-1)
-- [`casper-node-launcher-js plugins:link PLUGIN`](#casper-node-launcher-js-pluginslink-plugin)
-- [`casper-node-launcher-js plugins:uninstall PLUGIN...`](#casper-node-launcher-js-pluginsuninstall-plugin)
-- [`casper-node-launcher-js plugins:uninstall PLUGIN...`](#casper-node-launcher-js-pluginsuninstall-plugin-1)
-- [`casper-node-launcher-js plugins:uninstall PLUGIN...`](#casper-node-launcher-js-pluginsuninstall-plugin-2)
-- [`casper-node-launcher-js plugins update`](#casper-node-launcher-js-plugins-update)
-
-## `casper-node-launcher-js help [COMMANDS]`
-
-Display help for casper-node-launcher-js.
-
-```
-USAGE
-  $ casper-node-launcher-js help [COMMANDS] [-n]
-
-ARGUMENTS
-  COMMANDS  Command to show help for.
-
-FLAGS
-  -n, --nested-commands  Include all nested commands in the output.
-
-DESCRIPTION
-  Display help for casper-node-launcher-js.
-```
-
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
-
-## `casper-node-launcher-js plugins`
-
-List installed plugins.
-
-```
-USAGE
-  $ casper-node-launcher-js plugins [--core]
-
-FLAGS
-  --core  Show core plugins.
-
-DESCRIPTION
-  List installed plugins.
-
-EXAMPLES
-  $ casper-node-launcher-js plugins
-```
-
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.4.4/src/commands/plugins/index.ts)_
-
-## `casper-node-launcher-js plugins:install PLUGIN...`
-
-Installs a plugin into the CLI.
-
-```
-USAGE
-  $ casper-node-launcher-js plugins:install PLUGIN...
-
-ARGUMENTS
-  PLUGIN  Plugin to install.
-
-FLAGS
-  -f, --force    Run yarn install with force flag.
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Installs a plugin into the CLI.
-  Can be installed from npm or a git url.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
-  the CLI without the need to patch and update the whole CLI.
-
-
-ALIASES
-  $ casper-node-launcher-js plugins add
-
-EXAMPLES
-  $ casper-node-launcher-js plugins:install myplugin
-
-  $ casper-node-launcher-js plugins:install https://github.com/someuser/someplugin
-
-  $ casper-node-launcher-js plugins:install someuser/someplugin
-```
-
-## `casper-node-launcher-js plugins:inspect PLUGIN...`
-
-Displays installation properties of a plugin.
-
-```
-USAGE
-  $ casper-node-launcher-js plugins:inspect PLUGIN...
-
-ARGUMENTS
-  PLUGIN  [default: .] Plugin to inspect.
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-GLOBAL FLAGS
-  --json  Format output as json.
-
-DESCRIPTION
-  Displays installation properties of a plugin.
-
-EXAMPLES
-  $ casper-node-launcher-js plugins:inspect myplugin
-```
-
-## `casper-node-launcher-js plugins:install PLUGIN...`
+  ```sh
+  casper-node-launcher-js node
+  ```
 
-Installs a plugin into the CLI.
-
-```
-USAGE
-  $ casper-node-launcher-js plugins:install PLUGIN...
-
-ARGUMENTS
-  PLUGIN  Plugin to install.
-
-FLAGS
-  -f, --force    Run yarn install with force flag.
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Installs a plugin into the CLI.
-  Can be installed from npm or a git url.
-
-  Installation of a user-installed plugin will override a core plugin.
-
-  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
-  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
-  the CLI without the need to patch and update the whole CLI.
+## Commands
 
+You can list available commands by running
 
-ALIASES
-  $ casper-node-launcher-js plugins add
-
-EXAMPLES
-  $ casper-node-launcher-js plugins:install myplugin
-
-  $ casper-node-launcher-js plugins:install https://github.com/someuser/someplugin
-
-  $ casper-node-launcher-js plugins:install someuser/someplugin
+```sh
+casper-node-launcher-js help
 ```
 
-## `casper-node-launcher-js plugins:link PLUGIN`
-
-Links a plugin into the CLI for development.
+To get help for specific command run `casper-node-launcher-js help node`
 
+```sh
+casper-node-launcher-js help node
 ```
-USAGE
-  $ casper-node-launcher-js plugins:link PLUGIN
-
-ARGUMENTS
-  PATH  [default: .] path to plugin
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
 
-DESCRIPTION
-  Links a plugin into the CLI for development.
-  Installation of a linked plugin will override a user-installed or core plugin.
+## Troubleshoot
 
-  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
-  command will override the user-installed or core plugin implementation. This is useful for development work.
+If you have problems with OpenSSL, you need to install OpenSSL
 
-
-EXAMPLES
-  $ casper-node-launcher-js plugins:link myplugin
-```
-
-## `casper-node-launcher-js plugins:uninstall PLUGIN...`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ casper-node-launcher-js plugins:uninstall PLUGIN...
-
-ARGUMENTS
-  PLUGIN  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ casper-node-launcher-js plugins unlink
-  $ casper-node-launcher-js plugins remove
+```sh
+wget http://archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb # make sure library is compatible with your os.
+sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2_amd64.deb
 ```
-
-## `casper-node-launcher-js plugins:uninstall PLUGIN...`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ casper-node-launcher-js plugins:uninstall PLUGIN...
-
-ARGUMENTS
-  PLUGIN  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ casper-node-launcher-js plugins unlink
-  $ casper-node-launcher-js plugins remove
-```
-
-## `casper-node-launcher-js plugins:uninstall PLUGIN...`
-
-Removes a plugin from the CLI.
-
-```
-USAGE
-  $ casper-node-launcher-js plugins:uninstall PLUGIN...
-
-ARGUMENTS
-  PLUGIN  plugin to uninstall
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Removes a plugin from the CLI.
-
-ALIASES
-  $ casper-node-launcher-js plugins unlink
-  $ casper-node-launcher-js plugins remove
-```
-
-## `casper-node-launcher-js plugins update`
-
-Update installed plugins.
-
-```
-USAGE
-  $ casper-node-launcher-js plugins update [-h] [-v]
-
-FLAGS
-  -h, --help     Show CLI help.
-  -v, --verbose
-
-DESCRIPTION
-  Update installed plugins.
-```
-
-<!-- commandsstop -->
diff --git a/package.json b/package.json
@@ -1,10 +1,10 @@
 {
   "name": "casper-node-launcher-js",
-  "version": "0.0.2",
-  "description": "CLI for run single casper node for test purpose",
-  "author": "gyroflaw",
+  "version": "0.0.1",
+  "description": "CLI makes easy to run single casper node for test purpose",
+  "author": "Ryo Kanazawa <[email protected]>",
   "bin": {
-    "casper-node-launcher": "./bin/run"
+    "casper-node-launcher-js": "./bin/run"
   },
   "homepage": "https://github.com/casper-network/casper-node-launcher-js",
   "license": "MIT",
@@ -70,7 +70,10 @@
   },
   "bugs": "https://github.com/casper-network/casper-node-launcher-js/issues",
   "keywords": [
-    "oclif"
+    "oclif",
+    "casper",
+    "casper node",
+    "NCTL"
   ],
   "types": "dist/index.d.ts"
 }
diff --git a/src/commands/stop.ts b/src/commands/stop.ts
@@ -7,7 +7,7 @@ import { Args, Command } from "@oclif/core";
 import { NETWORK_NAMES, NODE_VERSIONS, WORK_DIR } from "../config";
 
 export default class Stop extends Command {
-  static description = "Generate config files";
+  static description = "Stop running node in background.";
 
   static args = {
     branch: Args.string({