This command is used to manage subsystems in apx. Subsystems are container-like entities that can be created based on pre-existing stacks. With the apx subsystems command, you can create new subsystems, list available subsystems, reset a specific subsystem to its initial state, and remove subsystems.

Use case 1: Interactively create a new subsystem

Code:

apx subsystems new

Motivation: You may want to create a new subsystem interactively to set up a separate environment for different purposes within your application stack.

Explanation: The command apx subsystems new is used to create a new subsystem. It does not require any additional arguments.

Example output:

Enter subsystem name: my-subsystem
Successfully created new subsystem 'my-subsystem'.

Use case 2: List all available subsystems

Code:

apx subsystems list

Motivation: You may want to check all the available subsystems in your apx environment to obtain an overview of all the separate environments you have set up.

Explanation: The command apx subsystems list is used to list all the available subsystems. It does not require any additional arguments.

Example output:

Available subsystems:
- my-subsystem
- other-subsystem

Use case 3: Reset a specific subsystem to its initial state

Code:

apx subsystems reset --name my-subsystem

Motivation: You may want to reset a specific subsystem to its initial state if you want to start fresh or resolve any issues that have occurred within that subsystem.

Explanation: The command apx subsystems reset is used to reset a specific subsystem. The --name argument must be provided, specifying the name of the subsystem to reset.

Example output:

Successfully reset subsystem 'my-subsystem' to its initial state.

Use case 4: [f]orce reset a specific subsystem

Code:

apx subsystems reset --name my-subsystem --force

Motivation: You may want to force reset a specific subsystem, even if there are active processes or resources that would normally prevent a reset.

Explanation: The command apx subsystems reset --force is used to force reset a specific subsystem. The --name argument must be provided, specifying the name of the subsystem to reset. The --force option is included to override any restrictions.

Example output:

Forcing reset of subsystem 'my-subsystem' to its initial state.

Use case 5: Remove a specific subsystem

Code:

apx subsystems rm --name my-subsystem

Motivation: You may want to remove a specific subsystem that is no longer needed, freeing up resources and ensuring no conflicts occur.

Explanation: The command apx subsystems rm is used to remove a specific subsystem. The --name argument must be provided, specifying the name of the subsystem to remove.

Example output:

Successfully removed subsystem 'my-subsystem'.

Use case 6: [f]orce remove a specific subsystem

Code:

apx subsystems rm --name my-subsystem --force

Motivation: You may want to force remove a specific subsystem, even if there are active processes or resources that would normally prevent a removal.

Explanation: The command apx subsystems rm --force is used to force remove a specific subsystem. The --name argument must be provided, specifying the name of the subsystem to remove. The --force option is included to override any restrictions.

Example output:

Forcing removal of subsystem 'my-subsystem'.

Conclusion:

The apx subsystems command provides a comprehensive set of features for managing subsystems in apx. Whether you need to create, list, reset, or remove subsystems, this command enables you to effectively manage and control different environments within your application stack.