Version: v8
Ionic CLI
The Ionic command-line interface (CLI) is the go-to tool for developing Ionic apps.
Installation
The Ionic CLI can be installed globally with npm:
npm install -g @ionic/cli
Help
The Ionic CLI ships with command documentation that is accessible with the--help flag.
$ ionic --help
$ ionic <command> --help
$ ionic <command> <subcommand> --help
note
Be sure to runionic <command> --help in your project directory.
For some commands, such asionic serve, the help documentation is contextual to the type of your project, e.g. React vs Angular.
Architecture
The Ionic CLI is built withTypeScript andNode.js. It supports Node 10.3+, but the latest Node LTS is always recommended. Follow development on the open sourceGitHub repository.
Troubleshooting
To troubleshoot issues with the Ionic CLI, the following may be useful:
- Make sure the latest version of the Ionic CLI is installed. Get the installed Ionic CLI version by running
ionic --version. The Ionic CLI version is not related to the Ionic Framework version. - Make sure the latest Node LTS is installed. SeeNode & npm environment setup.
- The
--verboseflag prints debugging messages, which may narrow down the issue. - Connection issues may be due to improperly configured proxy settings. SeeUsing a Proxy to configure request proxying.
- The global Ionic CLI configuration directory is
~/.ionicon all platforms. It can safely be deleted and the Ionic CLI will repopulate it, but all configuration (including user sessions) will be lost. Configure this directory withCLI environment variables.