https://github.com/rash-sh/rash

Declarative shell scripting using Rust native bindings inspired by Ansible
https://github.com/rash-sh/rash

bash cli cloud containers docker rust shell

Last synced: about 2 months ago
JSON representation

Declarative shell scripting using Rust native bindings inspired by Ansible

• Host: GitHub
• URL: https://github.com/rash-sh/rash
• Owner: rash-sh
• License: gpl-3.0
• Created: 2020-05-05T19:35:09.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T09:12:34.000Z (about 2 months ago)
• Last Synced: 2024-10-28T12:01:42.071Z (about 2 months ago)
• Topics: bash, cli, cloud, containers, docker, rust, shell
• Language: Rust
• Homepage: https://rash-sh.github.io
• Size: 1.07 MB
• Stars: 206
• Watchers: 11
• Forks: 7
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


# rash

![Build status](https://img.shields.io/github/actions/workflow/status/rash-sh/rash/rust.yml?branch=master)

[![Rash Docker image](https://img.shields.io/docker/image-size/rustagainshell/rash?sort=semver)](https://cloud.docker.com/repository/docker/rustagainshell/rash)

[![Documentation](https://docs.rs/rash_core/badge.svg)](https://docs.rs/rash_core)

[![crates.io](https://img.shields.io/crates/v/rash_core)](https://crates.io/crates/rash_core)

[![concept-map](https://img.shields.io/badge/design-concept--map-blue)](https://mind42.com/mindmap/f299679e-8dc5-48d8-b0f0-4d65235cdf56)

![Rash license](https://img.shields.io/github/license/rash-sh/rash)

[![Rash Aur package](https://img.shields.io/aur/version/rash)](https://aur.archlinux.org/packages/rash)

Declarative shell scripting using Rust native bindings inspired by [Ansible](https://www.ansible.com/)

## Getting Started & Documentation

For installation and usage, see our

[Documentation](https://rash.sh/docs/rash/master/getting-started.html#quickstart).

## Why Rash

Manage your scripts in a declarative style.

If you:

- think that long bash scripts are difficult to maintain

- love Ansible syntax to setup your environments

Or use it for your local scripts!

Then keep on reading.

Here is Rash!

### Declarative vs imperative

Imperative: `entrypoint.sh`:

```bash

#!/bin/bash

set -e

REQUIRED_PARAMS="

VAULT_URL

VAULT_ROLE_ID

VAULT_SECRET_ID

VAULT_SECRET_PATH

"

for required in $REQUIRED_PARAMS ; do

  [[ -z "${!required}" ]] && echo "$required IS NOT DEFINED" && exit 1

done

echo "[$0] Logging into Vault..."

VAULT_TOKEN=$(curl -s $VAULT_URL/v1/auth/approle/login \

--data '{"role_id": "'$VAULT_ROLE_ID'","secret_id": "'$VAULT_SECRET_ID'"}' \

| jq -r .auth.client_token)

echo "[$0] Getting Samuel API key from Vault..."

export APP1_API_KEY=$(curl -s -H "X-Vault-Token: $VAULT_TOKEN" \

$VAULT_URL/v1/$VAULT_SECRET_PATH | jq -r .data.api_key)

exec "$@"

```

Declarative: `entrypoint.rh`

```yaml

#!/bin/rash

- name: Verify input parameters

  assert:

    that:

      - env.VAULT_URL is defined

      - env.VAULT_ROLE_ID is defined

      - env.VAULT_SECRET_ID is defined

      - env.VAULT_SECRET_PATH is defined

- name: launch docker CMD

  command:

    cmd: { { rash.argv } }

    transfer_pid: yes

  env:

    APP1_API_KEY: "{{ lookup('vault', env.VAULT_SECRET_PATH ) }}"

```

### Docopts

[docopt](http://docopt.org/) implementation included:

- Easy to define interfaces for command-line app.

- Automatically generate a parser from doc.

Example:

```yaml

#!/usr/bin/env -S rash --

#

# Copy files from source to dest dir

#

# Usage:

#   copy.rh [options] ... 

#   copy.rh

#

# Options:

#   -h --help    show this help message and exit

#   --mode MODE  dest file permissions [default: 0644]

- copy:

    src: "{{ item }}"

    dest: "{{ dest }}/{{ item | split('/') | last }}"

    mode: "{{ options.mode }}"

  loop: "{{ source | default ([]) }}"

```

### Lightness

All you need to run Rash is a Linux kernel!

You can use it in your favorite IoT chips running Linux or in containers from scratch!

## Status

Stable API with few modules.