Cly is a powerful tool that enables the creation of feature-rich command aliases using YAML configuration. By allowing the definition of complex behaviors and commands, Cly streamlines automation tasks and enhances productivity within command-line environments.

Key Features

• Versatile Command Definition: Create seamless aliases for various commands with options for subcommands, concurrent execution, and parameters/environment variables.
• Structured YAML Configuration: Use clear YAML formatting for alias definitions, making it easy to manage and modify settings.
• OS agnostic: Will run on windows/linux and mac. Only prerequisite is GO.

Example Usage

Here’s a glimpse of how to define aliases in Cly using YAML:

update:
  command: /some/path/script.sh $@  # Adds arguments to alias, e.g. cly run update <x> <y>
  subcommands:
  - name: ping  # Subcommand used as: cly run update <ping>
    command: /some/path/script.sh

dashboard:
  command: streamlit run main.py
  dir: /path/to/python/  # Sets a specific directory for execution

python:               # Use indexed arguments, e.g. cly run test <python3.12>
  command: $0 test.py

create-file:
  concurrent: true  # Executes following commands concurrently
  commands:
  - touch $0
  - echo hi > $0

hi:
  command: python3 test/env.py
  envs:
  - name: AWS_REGION  # Adds environmental variable
    value: us-east-1
  - name: CITY
    value: Rotterdam

Commands Overview

Cly operates with two primary commands: run <<command>> and ls. The setup allows for extensive customization of alias functionalities, detailed in the following table:

Parameters Handling

Parameters for aliases can be passed during invocation, utilizing bash syntax. $@ captures all parameters, while $0...n allows inserting particular arguments based on their index.

Cly is easy to install with the command: go install github.com/TimoKats/cly@latest, and the customizable nature of this tool makes it a valuable asset for developers aiming to enhance their command-line efficiency.