Overview
This node acts as a wrapper around the Cycloid CLI tool, allowing users to execute Cycloid commands directly within an n8n workflow. It supports running different operations on specified resources by invoking the CLI with optional additional arguments. This is useful for automating infrastructure or deployment tasks managed by Cycloid without leaving the n8n environment.
Common scenarios include:
- Creating or listing Cycloid events programmatically.
- Extending workflows with custom Cycloid CLI commands by passing extra arguments.
- Integrating Cycloid operations into broader automation pipelines.
For example, a user might list all events in their Cycloid organization or create a new event by specifying the operation and resource, optionally adding CLI arguments for more control.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | A collection of optional fields to customize the CLI command. |
| Arguments | Additional string arguments to append to the Cycloid CLI command when executed. |
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 execution, including API URL, API key, and organization identifier.stdout: The standard output returned by the CLI command.stderr: The standard error output from the CLI command.
This output provides detailed information about the command execution result, which can be used for further processing or debugging.
Dependencies
- Requires the Cycloid CLI binary accessible at a relative path inside the node's distribution folder.
- Needs an API key credential and related configuration (API URL and organization canonical name) to authenticate CLI commands.
- Uses Node.js child process execution capabilities to run the CLI commands.
- Environment variables are set dynamically for each command execution to pass authentication and configuration details.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- If the Cycloid CLI binary is not found at the expected path, the command execution will fail.
- Invalid additional arguments may cause the CLI to return errors.
Error messages:
- Errors thrown during CLI execution 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 relate to command syntax, authentication failure, or environment misconfiguration.
Resolutions:
- Verify that the API key and other credentials are correctly configured.
- Ensure the Cycloid CLI is properly installed and accessible.
- Validate any additional arguments passed to avoid syntax errors.