Skip to content

Commit

Permalink
update CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Evgeny Metelkin committed Dec 17, 2023
1 parent 1210950 commit f38d6e4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
2 changes: 0 additions & 2 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@

## bugs

- `--skip-updates` in docs
- `heta update` in docs

## features

Expand Down
16 changes: 16 additions & 0 deletions cli-references.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ List of `heta build` options:
| --meta-dir | \<string\> | | Set meta directory path. |
| --log-mode | string | error | The rule in which case the log file should be created. Possible values are: never/error/always |
| -d, --declaration | string | platform | The filepath to declaration file (see below) without extension. The command will search the declaration file based on option trying a set of extensions: .json/.json5/.yml. |
| --skip-updates | | | Do not check available new version in npm. |

#### Example 1

Expand Down Expand Up @@ -157,6 +158,21 @@ If we check the content of the created "test" directory we will see the followin

**.gitattributes, .gitignore** : templates to help working with [Git](https://git-scm.com/)

## "heta update" command

`heta update` installs the latest version of heta-compiler available on NPM.

If the additional argument `[version]` is set then it will install the selected version.

The command is equivalen to `npm install --global heta-compiler`.

#### Example

To install the selected version.

```bash
heta update 0.7.1
```

## "heta help" command

Expand Down

0 comments on commit f38d6e4

Please sign in to comment.