Access Non-Interactive CLI

# Access Non-Interactive CLI

Execute the following command to install the Catalyst CLI globally:

npm install -g zcatalyst-cli

Note: If the command fails, try again with elevated privileges: sudo on macOS/Linux, or a terminal running as administrator on Windows.

You can verify the installation by executing the following command:

catalyst --version

Note: Catalyst CLI requires Node.js v14 or higher to install, as npm is bundled with Node.js.

### Update the CLI

A running log of all of Catalyst CLI updates is available in the Catalyst Release Notes. To update your Catalyst CLI, execute the following command:

npm install -g zcatalyst-cli

To update to a specific version, execute the following command:

npm install -g zcatalyst-cli@&lt;version&gt;

### Troubleshooting CLI installation

If you are unable to install the Catalyst CLI try troubleshooting with the following steps:

* Confirm Node and npm versions by executing node -v and npm -v. If they return a compatible version (v14 or higher), then uninstall and reinstall Catalyst CLI (use sudo on macOS, or an administrator command prompt on Windows).
* If you hit a TLS authorization error, run set NODE_TLS_REJECT_UNAUTHORIZED=0, then retry the command. This disables TLS certificate verification for the session. Only use it as a temporary workaround, and set it back afterward (set NODE_TLS_REJECT_UNAUTHORIZED=1).
* If the CLI shows abnormal behavior, check the catalyst-debug.log file created automatically in the directory the command was run from, and send it to support@zohocatalyst.com with a description of the issue.

### Access Non-interactive Mode in Catalyst CLI

You can access the Non-interactive mode in the Catalyst CLI either using a command flag, environment variable, or programmatically using the appropriate argument.

<table class="content-table">
    <thead>
        <tr>
            <th class="w30p">Method</th>
            <th class="w40p">How to activate</th>
            <th class="w30p">Example</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td>Command flag</td>
            <td>Add -ni (or --non-interactive) to any command</td>
            <td>catalyst functions:add -ni --name InvoiceFetch --type bio --stack node20</td>
        </tr>
        <tr>
            <td>Environment variable</td>
            <td>Set ZCATALYST_NON_INTERACTIVE to 1, true, or yes. (This applies to every command in that terminal session.)</td>
            <td>For macOS/Linux: export ZCATALYST_NON_INTERACTIVE=1<br />OR<br />For Windows: ZCATALYST_NON_INTERACTIVE=1</td>
        </tr>
        <tr>
            <td>Programmatically</td>
            <td>Pass the non-interactive option when invoking the CLI from code.</td>
            <td>Pass the equivalent of -ni as an argument in your script/CI call to the CLI.</td>
        </tr>
    </tbody>
</table>

Note: Execute catalyst &lt;command&gt; -ni --help to access the non-interactive CLI specific help section for that command.

Execute the following command to install the Catalyst CLI globally:

copy
$npm install -g zcatalyst-cli

Note: If the command fails, try again with elevated privileges: sudo on macOS/Linux, or a terminal running as administrator on Windows.

You can verify the installation by executing the following command:

copy
$catalyst --version

Note: Catalyst CLI requires Node.js v14 or higher to install, as npm is bundled with Node.js.

Update the CLI

A running log of all of Catalyst CLI updates is available in the Catalyst Release Notes. To update your Catalyst CLI, execute the following command:

copy
$npm install -g zcatalyst-cli

To update to a specific version, execute the following command:

copy
$npm install -g zcatalyst-cli@<version>

Troubleshooting CLI installation

If you are unable to install the Catalyst CLI try troubleshooting with the following steps:

Confirm Node and npm versions by executing node -v and npm -v. If they return a compatible version (v14 or higher), then uninstall and reinstall Catalyst CLI (use sudo on macOS, or an administrator command prompt on Windows).
If you hit a TLS authorization error, run set NODE_TLS_REJECT_UNAUTHORIZED=0, then retry the command. This disables TLS certificate verification for the session. Only use it as a temporary workaround, and set it back afterward (set NODE_TLS_REJECT_UNAUTHORIZED=1).
If the CLI shows abnormal behavior, check the catalyst-debug.log file created automatically in the directory the command was run from, and send it to support@zohocatalyst.com with a description of the issue.

Access Non-interactive Mode in Catalyst CLI

You can access the Non-interactive mode in the Catalyst CLI either using a command flag, environment variable, or programmatically using the appropriate argument.

Method	How to activate	Example
Command flag	Add -ni (or –non-interactive) to any command	catalyst functions:add -ni –name InvoiceFetch –type bio –stack node20
Environment variable	Set ZCATALYST_NON_INTERACTIVE to 1, true, or yes. (This applies to every command in that terminal session.)	For macOS/Linux: export ZCATALYST_NON_INTERACTIVE=1 OR For Windows: ZCATALYST_NON_INTERACTIVE=1
Programmatically	Pass the non-interactive option when invoking the CLI from code.	Pass the equivalent of -ni as an argument in your script/CI call to the CLI.