engines:delete#

relationalai.cli
#rai engines:delete [OPTIONS]

Delete an engine.

Options#

OptionTypeDescription
--nameTextThe name of the engine to delete. If missing, you are prompted to enter the name interactively.
--forceFlagIf set, forces the deletion of the engine even if it is actively in use.

Example#

Use the engines:delete command to delete an existing RelationalAI engine.

To delete an engine named my_engine, execute the following command:

#$ rai engines:delete --name my_engine

---------------------------------------------------

▰▰▰▰ Engine 'my_engine' deleted!

---------------------------------------------------

If no engine named my_engine exists, an error message is displayed:

#$ rai engines:delete --name my_engine

---------------------------------------------------

Engine 'my_engine' not found

---------------------------------------------------

If the --name option is missing, you are prompted to select the engine name interactively:

#$ rai engines:delete

---------------------------------------------------

▰▰▰▰ Fetched engines

? Select an engine:
┌──────────────────────────────────────────────────┐
│❯   3/3                                           │
│❯ [REFETCH LIST]                                  │
│  my_engine                                       │
│  my_other_engine                                 │
└──────────────────────────────────────────────────┘

▰▰▰▰ Engine 'my_engine' deleted!

---------------------------------------------------

Use the up and down arrow keys to navigate the list of engines. You can search for an engine by typing part of its name in the prompt.

To force the deletion of an engine named my_engine even if it is actively in use, execute the following command:

#$ rai engines:delete --name my_engine --force

---------------------------------------------------

▰▰▰▰ Engine 'my_engine' deleted!

---------------------------------------------------

See Also#