1 | ## Misk CLI
|
2 |
|
3 | ![](https://raw.githubusercontent.com/cashapp/misk/master/misk.png)
|
4 | This package provides the Misk CLI tool that generates build files for Misk Tabs.
|
5 |
|
6 | ## Getting Started
|
7 |
|
8 | ```bash
|
9 | $ npm install -g @misk/cli
|
10 | ```
|
11 |
|
12 | ## Commands
|
13 |
|
14 | ```Bash
|
15 | Misk Web CLI Usage: $ miskweb <command> <required arg> [optional arg] [options]
|
16 |
|
17 | Commands:
|
18 | miskweb auto-pin [filename] auto-pin searches upstream for a [filename]
|
19 | (default: master-dependencies.json) and uses the
|
20 | pinned version in key `miskWebNPM` for all tab
|
21 | Misk Web dependencies
|
22 |
|
23 | miskweb build run a fast Webpack development build
|
24 |
|
25 | miskweb ci-build npm install, then Webpack production build, tests
|
26 |
|
27 | miskweb clean remove lib directory and other temporary files
|
28 |
|
29 | miskweb install install node_modules dependencies
|
30 |
|
31 | miskweb lint use prettier to lint all files
|
32 |
|
33 | miskweb misk generate multibindings to configure tab with a
|
34 | Misk service
|
35 |
|
36 | miskweb new create a new tab in the current directory
|
37 |
|
38 | miskweb path <URLpath> set relative URL path where tab will be served in
|
39 | browser. Provides support for a non-Misk Admin
|
40 | Dashboard tab that is a dedicated Misk Web front
|
41 | end
|
42 |
|
43 | miskweb pin <pinnedVersion> pin version for all tab Misk Web dependencies
|
44 |
|
45 | miskweb prebuild use miskTab.json to generate build files
|
46 |
|
47 | miskweb start start Webpack Dev Server for live editing
|
48 |
|
49 | miskweb tabs prints path of all downstream tabs
|
50 |
|
51 | miskweb test-coverage generate test coverage report
|
52 |
|
53 | miskweb test-update update test snapshots
|
54 |
|
55 | miskweb test run tests
|
56 |
|
57 | miskweb update update Misk Web CLI
|
58 |
|
59 | miskweb zip zip source code for tab
|
60 |
|
61 |
|
62 | Options:
|
63 | -e, --each run command in all subdirectories that have miskTab.json [boolean]
|
64 | --help Show help [boolean]
|
65 | --version Show version number [boolean]
|
66 | ```
|
67 |
|
68 | ## [Releasing](https://github.com/cashapp/misk-web/blob/master/RELEASING.md)
|
69 |
|
70 | ## [Changelog (and Breaking Changes)](https://github.com/cashapp/misk-web/blob/master/CHANGELOG.md)
|