CLI documentation
The Aineko CLI is a development tool that allows you to get started quickly and introspect your pipeline runs more expediently.
aineko
Aineko CLI.
Usage:
aineko [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--help Show this message and exit.
aineko create
Creates boilerplate code and config required for an Aineko pipeline.
If repo is set, attempts to clone and use the files from the repo. The following files are required:
- aineko.yml: Contains required data to create an aineko pipeline.
Requires keys:
- aineko_version: Version of aineko to use.
- project_name: Name of the aineko project.
- project_slug: (optional) slug of project. Can only contain
alphanumeric characters and underscores. Will be derived from
project_name if not provided.
- project_description: (optional) Description of the pipeline.
- pipeline_slug: (optional) name of pipeline (alphanumeric
characters, dashes and underscores only).
- <<project_name>>/nodes.py or <<project_name>>/nodes/*.py: Either a
file containing all node code or a directory containing multiple
node code files.
- conf/*.yml: Directory containing config files for pipelines.
The following files are optional, and will overwrite the default files:
- README.md: README file for the repo.
- pyproject.toml: Project configuration, including poetry requirements
- deploy.yml: Project deployment configuration.
- <
Args: deployment_config: If True, include a deploy file when generating, else do not include. output_dir: Directory to create pipeline in. Defaults to current. no_input: If True, do not prompt for parameters and use defaults. repo: GitHub repo to create pipeline from. Link should contain branch or rev to reference.
Usage:
aineko create [OPTIONS]
Options:
-d, --deployment-config Include deploy.yml that
facilitates deployment
of pipelines.
-o, --output-dir TEXT Directory to create
pipeline in. Defaults
to current directory.
-n, --no-input Do not prompt for
parameters and use
defaults.
-r, --repo TEXT GitHub repo to create
pipeline from. Link
should contain branch
or rev to reference.
(Ex aineko-dev/dream-
catcher#my-branch)
Refer to CLI docs for
more info on repo
structure.
--help Show this message and
exit.
aineko dream
Main function to generate an aineko project using Aineko Dream.
Args: prompt: Prompt to generate a project from. api_key: API key to use for the Aineko Dream API. url: URL to use for the Aineko Dream API.
Usage:
aineko dream [OPTIONS] PROMPT API_KEY
Options:
-u, --url TEXT API url to use for the Aineko
Dream API.
--help Show this message and exit.
aineko run
Main function to run a pipeline from the command line.
Args: pipeline_config_file: Path to the file containing the pipeline config pipeline_name: Name of the pipeline to run, overrides pipeline config retry: If true, retry running the pipeline on failure every 10 seconds
Usage:
aineko run [OPTIONS] PIPELINE_CONFIG_FILE
Options:
-p, --pipeline-name TEXT Name of the pipeline
to run.
-r, --retry Retry running the
pipeline on failure.
--help Show this message and
exit.
aineko service
Manage Aineko docker services (Kafka and Zookeeper containers).
Usage:
aineko service [OPTIONS] COMMAND [ARGS]...
Options:
-c, --config TEXT Path to the custom Docker
Compose config file.
--help Show this message and exit.
aineko service down
Kill Aineko docker services.
Usage:
aineko service down [OPTIONS]
Options:
--help Show this message and exit.
aineko service restart
Restart Aineko docker services.
Usage:
aineko service restart [OPTIONS]
Options:
-H, --hard Forces full restart Aineko docker
services.Clears data from Kafka
cache.
--help Show this message and exit.
aineko service start
Start Aineko docker services.
Usage:
aineko service start [OPTIONS]
Options:
--help Show this message and exit.
aineko service stop
Stop Aineko docker services.
Usage:
aineko service stop [OPTIONS]
Options:
--help Show this message and exit.
aineko stream
Stream messages from a dataset.
Usage:
aineko stream [OPTIONS] DATASET
Options:
-b, --from-beginning If messages should be
streamed from the start
--help Show this message and
exit.
aineko visualize
Builds mermaid graph from an Aineko pipeline config.
Args: config_path: file path to pipeline yaml file direction: direction of the graph. legend: include a legend in the graph. browser: Whether to render graph in browser. Prints graph to stdout otherwise.
Usage:
aineko visualize [OPTIONS] CONFIG_PATH
Options:
-d, --direction [TD|LR] Direction of the graph.
Either LR (left to
right) or TD (top
down).
-l, --legend Include a legend in the
graph.
-b, --browser Render graph in
browser. Prints graph
to stdout otherwise.
--help Show this message and
exit.
Shell completion
Aineko supports shell completion for Bash and Zsh. To enable it, follow the instructions below.
Please select your shell
Add this to ~/.bashrc:
eval "$(_AINEKO_COMPLETE=bash_source aineko)"
Add this to ~/.zshrc:
eval "$(_AINEKO_COMPLETE=zsh_source aineko)"