Skip to main content
Version: current

Pureprofile CLI

The Pureprofile command-line interface s the go-to tool for developing Pureprofile apps.

Installation​

The Pureprofile CLI can be installed globally with npm:

$ npm install -g @pureprofile/cli

Help​

The Pureprofile CLI ships with command documentation that is accessible with the --help flag.

$ pureprofile --help
$ pureprofile <command> --help
$ pureprofile <command> <subcommand> --help
note

Be sure to run pureprofile <command> --help in your project directory.

For some commands, such as pureprofile serve, the help documentation is contextual to the type of your project, e.g. React vs Angular.

Architecture​

The Pureprofile CLI is built with. It supports Node 10.3+, but the latest Node LTS is always recommended. Follow development on the open source GitHub repository.

Troubleshooting​

To troubleshoot issues with the Pureprofile CLI, the following may be useful:

  • Make sure the latest version of the Pureprofile CLI is installed. Get the installed version by running pureprofile --version.
  • Make sure the latest Node LTS is installed. See environment setup.
  • The --verbose flag prints debugging messages, which may narrow down the issue.
  • Connection issues may be due to improperly configured proxy settings. See to configure request proxying.
  • The global Pureprofile CLI configuration directory is ~/.pureprofile on all platforms. It can safely be deleted and the Pureprofile CLI will repopulate it, but all configuration (including user sessions) will be lost. Configure this directory with.