Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

grunt-cli

gruntjs3.5mMIT1.5.0

The grunt command line interface

readme

grunt-cli Build Status: Linux Build Status: Windows

The Grunt command line interface.

Install this globally and you'll have access to the grunt command anywhere on your system.

npm install -g grunt-cli

Note: The job of the grunt command is to load and run the version of Grunt you have installed locally to your project, irrespective of its version. Starting with Grunt v0.4, you should never install Grunt itself globally. For more information about why, please read this.

See the Getting Started guide for more information.

Shell tab auto-completion

To enable tab auto-completion for Grunt, add one of the following lines to your ~/.bashrc or ~/.zshrc file.

# Bash, ~/.bashrc
eval "$(grunt --completion=bash)"
# Zsh, ~/.zshrc
eval "$(grunt --completion=zsh)"

Installing grunt-cli locally

If you prefer the idiomatic Node.js method to get started with a project (npm install && npm test) then install grunt-cli locally with npm install grunt-cli --save-dev. Then add a script to your package.json to run the associated grunt command: "scripts": { "test": "grunt test" }. Now npm test will use the locally installed ./node_modules/.bin/grunt executable to run your Grunt commands.

To read more about npm scripts, please visit the npm docs: https://docs.npmjs.com/misc/scripts.

changelog

  • v1.5.0:
    • date: 2024-07-20
    • changes:
      • Update "v8flags" dependency to support FIPS-enabled systems.
      • Update "nopt"d peendency to fix "osenv" deprecation warning.
  • v1.4.1:
    • date: 2021-05-24
    • changes:
      • fix preload option for latest grunt
  • v1.4.0:
    • date: 2021-03-25
    • changes:
      • updated dependencies
      • Requires node >= 10
  • v1.3.2:
    • date: 2018-11-04
    • changes:
      • bump v8 flags dependency
  • v1.3.1:
    • date: 2018-08-18
    • changes:
      • cwd option fix
  • v1.3.0:
    • date: 2018-08-15
    • changes:
      • Switch to 'liftoff' module for CLI
      • Dropped support for node 0.10, 0.12.
  • v1.2.0
    • date: 2016-04-01
    • changes:
      • Use shared grunt-known-options module.
  • v1.1.0
    • date: 2016-03-22
    • changes:
      • Update to "nopt": "~3.0.6".
      • nopt is upgraded to ~3.0.6 which has fixed many issues, including passing multiple arguments and dealing with numbers as options. Be aware previously --foo bar used to pass the value 'bar' to the option foo. It will now set the option foo to true and run the task bar.
  • v1.0.1
    • date: 2016-03-22
    • changes:
      • Revert to "nopt": "~1.0.10" due to issues with the update.
  • v1.0.0
    • date: 2016-03-21
    • changes:
      • Update dev deps
      • Update error message when Gruntfile is not found
  • v1.0.0-rc1
    • date: 2016-02-11
    • changes:
      • Update findup-sync and other deps
      • remove prefer global warning