Skip to content
  • There are no suggestions because the search field is empty.

How to apply settings and profiles in CLI

Including how to use settings, discovering available settings, setting profiles and enabling logging.

Using Settings in the CLI

There are two ways to use settings with Nipper via the command line:

  1. Temporary Settings (Default Profile):
    You can specify settings directly in your command line. These must be declared before the --input or --device argument that initiates the audit. Settings applied this way are temporary and do not persist after the audit completes - they apply only to the default profile for that session.

  2. Persistent Settings (Custom Profile):
    If you want your settings to persist across multiple CLI sessions, you’ll need to save them in a custom settings profile. Once saved, Nipper will continue to use these settings until you update them or switch to a different profile.

Discovering Available Settings

To explore available settings, start by running:

nipper –-help setting

This will display a list of setting collections, each starting with a period (e.g. “.Save.ASCII”). Please note that collection names are case-sensitive.

To view the individual settings within a specific collection, run (for example):

nipper --help .Save.ASCII

You can apply any of these settings directly in your command line using the --set command. For example:

nipper --set Report.SECURITY.DEVICES=off

Settings Profiles

Nipper uses profiles to manage persistent settings. Profiles enable you to save a snapshot of your Nipper settings and restore them later. You can also export these settings profiles to a file for import on another system.

To learn more about profile management, run:

nipper --help profiles

Key commands include:

  • --save-profile - Saves the current settings as a named profile

  • --list-profile - Displays all available profiles

  • --use-profile <profile name> - Switches to the specified profile

Enabling Logging via CLI

Although Nipper supports event logging, the CLI currently only supports text-based file logging.

To set up logging:

1. Create a log collection:

nipper --collection LOGGING add=MyLoggingCollection

2. Verify the log exists:

nipper --collection LOGGING list

Your new log (MyLoggingCollection) should appear and be selected by default.

3. Configure file output for the log:

nipper --set LOGGING.MyLoggingCollection.FILE="C:\Users\Nipper\Documents\NipperLogging.txt"

To see all available log options, run:

nipper --help .LOGGING

When you run your audit, the specified log file (NipperLogging.txt) should be created with the relevant log entries.