Skip to content

Commit

Permalink
docs: 📚️ added --monitor
Browse files Browse the repository at this point in the history
  • Loading branch information
folke committed Mar 13, 2020
1 parent 422e1da commit 8a1b63f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* **faster script execution**: `ultra` hijacks any `npm`, `pnpm`, `yarn` and `npx` calls for faster execution.
* **concurrency within scripts**: you can add optional configuration to `package.json` to run parts of a script in parallel. No need to change the actual `scripts`
* **filtering**: filter on package names or subdirectories
* **monitoring**: node process monitor *(like `top` for node)*
* **output zooming** when executing multiple commands in parallel, `ultra` will try to keep as much concurrent output on the screen as possible, by only showing the last lines of the commands. Once the commands complete running, a full log is written to the terminal. This is very useful when building a bunch of packages with `--watch` for instance.
* **missing scripts** when executing scripts recursively, only packages that have the script defined, will execute it.

Expand Down Expand Up @@ -97,6 +98,14 @@ $ ultra -r --build mycustombuildscript

If for some reason you want to rebuild a package, use `--rebuild` or `rebuild`.

## :bar_chart: Monitor

With `ultra --monitor` you can easily monitor all running node processes on your machine.

For every process, you can also see the package where the command was executed and a clean command line.

![Monitor](assets/monitor.png)

## :zap: Fast

**Ultra** parses your `package.json` scripts and will only execute the commands that are really needed. Any script interdependencies are resolved during the parsing stage.
Expand Down Expand Up @@ -182,6 +191,8 @@ Workspace:
Status:
--info Show workspace dependencies [boolean]
--list List package scripts. Also works with --recusive [boolean]
--monitor Show node process list, updated every 2 seconds [boolean]
--monitor-interval Set process list interval in seconds [number] [default: 2]

Build:
--build, -b Use dependency tree to build packages in correct order [boolean]
Expand Down
Binary file added assets/monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8a1b63f

Please sign in to comment.