Update: Added documentation

inkdevhub · Nov 1, 2023 · 93aa5dc · 93aa5dc
1 parent 14f3397
commit 93aa5dc
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/.github/ISSUE_TEMPLATE/backlog-ticket.md b/.github/ISSUE_TEMPLATE/backlog-ticket.md
@@ -1,7 +1,7 @@
 ---
 name: Clear command
 about: New feature/clearCommand
-title: ''
+title: 'Clear command'
 labels: ''
 assignees: ''
 

diff --git a/README.md b/README.md
@@ -213,6 +213,7 @@ USAGE
 * [`swanky node install`](#swanky-node-install)
 * [`swanky node purge`](#swanky-node-purge)
 * [`swanky node start`](#swanky-node-start)
+* [`swanky clear CONTRACTNAME`](#)
 * [`swanky plugins`](#swanky-plugins)
 * [`swanky plugins:install PLUGIN...`](#swanky-pluginsinstall-plugin)
 * [`swanky plugins:inspect PLUGIN...`](#swanky-pluginsinspect-plugin)
@@ -558,6 +559,25 @@ DESCRIPTION
   Start a local node
 ```
 
+## `swanky clear`
+
+Clear the artifacts
+
+```
+USAGE
+  $ swanky clear [CONTRACTNAME] [-v] [-a]
+
+ARGUMENTS
+  CONTRACTNAME  Name of the contract artifact to clear
+
+FLAGS
+  -a, --all      Select all the project artifacts for delete
+  -v, --verbose  Display more info in the result logs
+
+DESCRIPTION
+  Clear the artifacts
+```
+
 ## `swanky plugins`
 
 List installed plugins.

diff --git a/src/commands/clear/index.ts b/src/commands/clear/index.ts
@@ -13,6 +13,7 @@ export default class Clear extends SwankyCommand<typeof Clear> {
   static flags = {
     all: Flags.boolean({
       char: "a",
+      description: "Select all the project artifacts for delete"
     }),
   };