Non-Interactive Catalyst CLI Commands

# Non-Interactive Catalyst CLI Commands

The following help section details all the Catalyst CLI commands that are compatible and non-compatible with Non-interactive mode.

### Global CLI Options

The following table covers the options that are possible in the Catalyst CLI:

<table class="content-table">
	<thead>
		<tr>
			<th>Options</th>
			<th>Purpose</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td><strong>--ni</strong> | <strong>--non-interactive</strong></td>
			<td>Turns on non-interactive mode for the command</td>
		</tr>
		<tr>
			<td><strong>--dc &lt;data-center&gt;</strong></td>
			<td>Selects the data center (us, eu, in, au, ca, sa, jp, uae)</td>
		</tr>
		<tr>
			<td><strong>--org &lt;org&gt;</strong></td>
			<td>Selects the organization/portal (name or ID)</td>
		</tr>
		<tr>
			<td><strong>--project &lt;project&gt;</strong></td>
			<td>Selects the project (name or ID)</td>
		</tr>
	</tbody>
</table>

### Commands That Support Non-Interactive Mode

The following table details all the Catalyst CLI commands that are compatible with non-interactive mode:

<table class="content-table">
	<thead>
		<tr>
			<th class="w15p">Command</th>
			<th class="w15p">Required Options</th>
			<th class="w30p">Good to Know</th>
			<th class="w40p">NI CLI Command</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>catalyst init</td>
			<td><strong>--project</strong></td>
			<td>
				<ul>
					<li>--org required only if more than one org exists (a single org is chosen automatically).</li>
					<li>Only project initialization is supported in NI mode.</li>
					<li>--force overwrites an existing project association.</li>
				</ul>
			</td>
			<td>catalyst init -ni --project MyProject</td>
		</tr>
		<tr>
			<td>catalyst functions:add</td>
			<td>
				<ul>
					<li><strong>--name</strong></li>
					<li><strong>--type</strong></li>
					<li><strong>--stack</strong></li>
				</ul>
			</td>
			<td>
				<ul>
					<li>Replaces functions:setup.</li>
					<li>--integ-service required only when --type is integ.</li>
					<li>--overwrite required only to replace an existing function of the same name.</li>
					<li>Sample class/entry-point names use built-in defaults; dependency installation is confirmed automatically.</li>
				</ul>
			</td>
			<td>catalyst functions:add -ni --name InvoiceFetch --type bio --stack node20</td>
		</tr>
		<tr>
			<td>catalyst functions:delete</td>
			<td><strong>[function name or ID]</strong></td>
			<td>
				<ul>
					<li>Defaults to local deletion if no location is specified.</li>
					<li>--remote is blocked in NI mode.</li>
					<li>Delete confirmation is accepted automatically.</li>
				</ul>
			</td>
			<td>catalyst functions:delete -ni InvoiceFetch</td>
		</tr>
		<tr>
			<td>catalyst functions:execute</td>
			<td><strong>[function name]</strong> conditional</td>
			<td>
				<ul>
					<li>Replaces functions:shell.</li>
					<li>Function name required only if more than one function exists.</li>
					<li>--key required only when the function has multiple named inputs.</li>
					<li>--input and --debug are optional.</li>
				</ul>
			</td>
			<td>catalyst functions:execute -ni InvoiceFetch --input '{"orderId":"123"}'</td>
		</tr>
		<tr>
			<td>catalyst appsail:add</td>
			<td>
				<ul>
					<li><strong>--name</strong></li>
					<li><strong>--source</strong></li>
				</ul>
			</td>
			<td>
				<ul>
					<li>Runtime (Catalyst-managed vs. Docker) is detected from --source.</li>
					<li>--stack required for Catalyst-managed runtime.</li>
					<li>--platform conditional for Java.</li>
					<li>--port is ignored (with warning) for managed runtime.</li>
					<li>--stack/--build/--platform/--overwrite-config are ignored for Docker runtime.</li>
					<li>--overwrite-config required only to replace an existing service config.</li>
				</ul>
			</td>
			<td>catalyst appsail:add -ni --name MyApp --source ./app --stack node20</td>
		</tr>
		<tr>
			<td>catalyst client:setup</td>
			<td>
				<ul>
					<li><strong>--type</strong></li>
					<li><strong>--name</strong></li>
				</ul>
			</td>
			<td>
				<ul>
					<li>--flavour required only for React (js/ts).</li>
					<li>--stylesheet conditional for Angular.</li>
					<li>--routing optional, Angular only.</li>
					<li>--overwrite required only if the client folder already exists.</li>
				</ul>
			</td>
			<td>catalyst client:setup -ni --type react --name myclient --flavour js</td>
		</tr>
		<tr>
			<td>catalyst client:delete</td>
			<td><strong>[client version]</strong> optional</td>
			<td>
				<ul>
					<li>Defaults to local deletion if no location is specified.</li>
					<li>--remote is blocked in NI mode.</li>
					<li>Delete confirmation is accepted automatically.</li>
				</ul>
			</td>
			<td>catalyst client:delete -ni 1.0.0</td>
		</tr>
		<tr>
			<td>catalyst slate:link</td>
			<td><strong>--source</strong></td>
			<td>
				<ul>
					<li>--name and --framework optional (framework auto-detected; a valid --framework overrides detection).</li>
					<li>--template and --default are ignored with a warning.</li>
				</ul>
			</td>
			<td>catalyst slate:link -ni --source ./my-app</td>
		</tr>
		<tr>
			<td>catalyst slate:create</td>
			<td>
				<ul>
					<li><strong>--name</strong></li>
					<li><strong>--framework</strong></li>
				</ul>
			</td>
			<td>
				<ul>
					<li>--template optional.</li>
					<li>No --source option, since create always scaffolds a fresh directory.</li>
					<li>--default is ignored with a warning.</li>
				</ul>
			</td>
			<td>catalyst slate:create -ni --name MyApp --framework react</td>
		</tr>
		<tr>
			<td>catalyst slate:unlink</td>
			<td><strong>--name</strong></td>
			<td>
				<ul>
					<li>An unknown or missing name fails with the list of available apps.</li>
					<li>--remove-source optional (deletes the source directory; kept by default).</li>
				</ul>
			</td>
			<td>catalyst slate:unlink -ni --name MyApp</td>
		</tr>
		<tr>
			<td>catalyst pull</td>
			<td>
				<ul>
					<li><strong>[feature]</strong></li>
					<li><strong>--resource</strong></li>
				</ul>
			</td>
			<td>
				<ul>
					<li>Only one feature pulled per run.</li>
					<li>--overwrite required only if the target already exists locally.</li>
					<li>Enabling and pulling API Gateway rules is confirmed automatically.</li>
				</ul>
			</td>
			<td>catalyst pull -ni functions --resource InvoiceFetch</td>
		</tr>
		<tr>
			<td>catalyst deploy slate</td>
			<td><strong>[name]</strong></td>
			<td>
				<ul>
					<li>-m &lt;message&gt; optional deploy message.</li>
					<li>--production deploys to production.</li>
					<li>--no-wait skips waiting for completion.</li>
				</ul>
			</td>
			<td>catalyst deploy slate -ni MyApp</td>
		</tr>
		<tr>
			<td>catalyst login</td>
			<td><strong>--dc</strong></td>
			<td>
				<ul>
					<li>Data center must be specified; it is not prompted.</li>
					<li>--no-localhost and --force optional.</li>
				</ul>
			</td>
			<td>catalyst login -ni --dc us</td>
		</tr>
	</tbody>
</table>

### Commands That Are Disabled in Non-Interactive Mode

The following table details the Catalyst CLI commands that are disabled in non-interactive mode:

<table class="content-table">
	<thead>
		<tr>
			<th class="w15p">Command</th>
			<th class="w35p">Why It's Disabled</th>
			<th class="w15p">Use Instead</th>
			<th class="w35p">Complete Command</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>catalyst functions:setup</td>
			<td>It's the interactive setup wizard for the first function in a project. It walks through picking a function type, stack, and several other selections as prompts and doesn't have an option-driven equivalent for every step, so it's blocked outright rather than partially supported.</td>
			<td>catalyst functions:add</td>
			<td>catalyst functions:add -ni --name InvoiceFetch --type bio --stack node20</td>
		</tr>
		<tr>
			<td>catalyst functions:shell</td>
			<td>It launches a live Node shell session for testing and debugging a function interactively, which has no meaningful non-interactive form since the whole point is a human typing commands into it.</td>
			<td>catalyst functions:execute (for Event, Job, and Integration functions)</td>
			<td>catalyst functions:execute -ni InvoiceFetch --input '{"orderId":"123"}'</td>
		</tr>
	</tbody>
</table>

The following help section details all the Catalyst CLI commands that are compatible and non-compatible with Non-interactive mode.

Global CLI Options

The following table covers the options that are possible in the Catalyst CLI:

Options	Purpose
–ni \| –non-interactive	Turns on non-interactive mode for the command
–dc <data-center>	Selects the data center (us, eu, in, au, ca, sa, jp, uae)
–org <org>	Selects the organization/portal (name or ID)
–project <project>	Selects the project (name or ID)

Commands That Support Non-Interactive Mode

The following table details all the Catalyst CLI commands that are compatible with non-interactive mode:

Command	Required Options	Good to Know	NI CLI Command
catalyst init	–project	–org required only if more than one org exists (a single org is chosen automatically). Only project initialization is supported in NI mode. –force overwrites an existing project association.	copy $ catalyst init -ni --project MyProject
catalyst functions:add	–name –type –stack	Replaces functions:setup. –integ-service required only when –type is integ. –overwrite required only to replace an existing function of the same name. Sample class/entry-point names use built-in defaults; dependency installation is confirmed automatically.	copy $ catalyst functions:add -ni --name InvoiceFetch --type bio --stack node20
catalyst functions:delete	[function name or ID]	Defaults to local deletion if no location is specified. –remote is blocked in NI mode. Delete confirmation is accepted automatically.	copy $ catalyst functions:delete -ni InvoiceFetch
catalyst functions:execute	[function name] conditional	Replaces functions:shell. Function name required only if more than one function exists. –key required only when the function has multiple named inputs. –input and –debug are optional.	copy $ catalyst functions:execute -ni InvoiceFetch --input '{"orderId":"123"}'
catalyst appsail:add	–name –source	Runtime (Catalyst-managed vs. Docker) is detected from –source. –stack required for Catalyst-managed runtime. –platform conditional for Java. –port is ignored (with warning) for managed runtime. –stack/–build/–platform/–overwrite-config are ignored for Docker runtime. –overwrite-config required only to replace an existing service config.	copy $ catalyst appsail:add -ni --name MyApp --source ./app --stack node20
catalyst client:setup	–type –name	–flavour required only for React (js/ts). –stylesheet conditional for Angular. –routing optional, Angular only. –overwrite required only if the client folder already exists.	copy $ catalyst client:setup -ni --type react --name myclient --flavour js
catalyst client:delete	[client version] optional	Defaults to local deletion if no location is specified. –remote is blocked in NI mode. Delete confirmation is accepted automatically.	copy $ catalyst client:delete -ni 1.0.0
catalyst slate:link	–source	–name and –framework optional (framework auto-detected; a valid –framework overrides detection). –template and –default are ignored with a warning.	copy $ catalyst slate:link -ni --source ./my-app
catalyst slate:create	–name –framework	–template optional. No –source option, since create always scaffolds a fresh directory. –default is ignored with a warning.	copy $ catalyst slate:create -ni --name MyApp --framework react
catalyst slate:unlink	–name	An unknown or missing name fails with the list of available apps. –remove-source optional (deletes the source directory; kept by default).	copy $ catalyst slate:unlink -ni --name MyApp
catalyst pull	[feature] –resource	Only one feature pulled per run. –overwrite required only if the target already exists locally. Enabling and pulling API Gateway rules is confirmed automatically.	copy $ catalyst pull -ni functions --resource InvoiceFetch
catalyst deploy slate	[name]	-m <message> optional deploy message. –production deploys to production. –no-wait skips waiting for completion.	copy $ catalyst deploy slate -ni MyApp
catalyst login	–dc	Data center must be specified; it is not prompted. –no-localhost and –force optional.	copy $ catalyst login -ni --dc us

Commands That Are Disabled in Non-Interactive Mode

The following table details the Catalyst CLI commands that are disabled in non-interactive mode:

Command	Why It's Disabled	Use Instead	Complete Command
catalyst functions:setup	It's the interactive setup wizard for the first function in a project. It walks through picking a function type, stack, and several other selections as prompts and doesn't have an option-driven equivalent for every step, so it's blocked outright rather than partially supported.	catalyst functions:add	copy $ catalyst functions:add -ni --name InvoiceFetch --type bio --stack node20
catalyst functions:shell	It launches a live Node shell session for testing and debugging a function interactively, which has no meaningful non-interactive form since the whole point is a human typing commands into it.	catalyst functions:execute (for Event, Job, and Integration functions)	copy $ catalyst functions:execute -ni InvoiceFetch --input '{"orderId":"123"}'