Overview
This node integrates with the Cycloid CLI to perform operations on Cycloid resources via command-line commands. It is designed to execute Cycloid CLI commands dynamically based on user input, allowing automation of tasks such as creating or listing resources within Cycloid.
A common use case is automating infrastructure or event management workflows by invoking Cycloid CLI commands directly from n8n without manual intervention. For example, a user can create an event resource in Cycloid by specifying the operation and resource type, along with any additional CLI arguments needed.
Properties
| Name | Meaning |
|---|---|
| Operation | The action to perform. Options: Create, List. |
| Resource | The Cycloid resource to operate on. Only option available: Event. |
| Additional Fields | Additional fields to pass to the CLI command. |
| Arguments | (Inside Additional Fields) Extra string arguments appended to the CLI command execution. |
Output
The node outputs an array of items where each item contains a json object with the following structure:
command: The full CLI command string that was executed.env: The environment variables used during the command execution, including API URL, API key, and organization identifier.stdout: The standard output returned by the CLI command.stderr: The standard error output returned by the CLI command.
This output allows users to inspect the exact command run and its results or errors. The node does not produce binary data.
Dependencies
- Requires the Cycloid CLI executable accessible at a relative path (
../../../dist/bin/cy). - Needs an API key credential for authentication with Cycloid services.
- Environment variables are set dynamically for the CLI command:
- API URL
- API Key
- Organization canonical name
These must be configured properly in n8n credentials and environment for successful execution.
Troubleshooting
Common issues:
- Incorrect or missing API key or API URL will cause authentication failures.
- The Cycloid CLI executable must exist at the expected path; otherwise, the command will fail.
- Invalid additional arguments may cause the CLI command to error out.
Error messages:
- Errors thrown by the CLI command are captured and either cause the node to fail or, if "Continue On Fail" is enabled, are included in the output with the original input data.
- Typical errors include command not found, authentication errors, or invalid parameters.
Resolution tips:
- Verify the Cycloid CLI installation and path.
- Check API credentials and organization identifiers.
- Validate additional CLI arguments syntax.