https://github.com/malolm/my-corporate-bash

Display an ASCII format image at the start of your bash session.
https://github.com/malolm/my-corporate-bash

bash shell shell-script

Last synced: 2 months ago
JSON representation

Display an ASCII format image at the start of your bash session.

• Host: GitHub
• URL: https://github.com/malolm/my-corporate-bash
• Owner: MaloLM
• License: apache-2.0
• Created: 2024-10-09T12:36:21.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-10T10:10:00.000Z (over 1 year ago)
• Last Synced: 2025-03-23T17:47:33.133Z (over 1 year ago)
• Topics: bash, shell, shell-script
• Language: Shell
• Homepage:
• Size: 1.11 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# My-corporate-bash

[![release-version](https://img.shields.io/badge/Version-1.0.0-blue)]()

[![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/MaloLM/my-corporate-bash/blob/main/LICENSE)

[![language](https://img.shields.io/badge/Language-shell-blue)](https://en.wikipedia.org/wiki/Scripting_language)

Display an ASCII format image at the start of your bash session.

![software demonstration: an opened terminal is used to setup a company logo, then show the result, the user validates the result whoch is now configure at the start of any bash session.](./assets/demo.gif)

## Install

Go to the repository root to execute bellow command:

```shell

sudo bash install

```

### ⚠️ Requirements ⚠️

You will need to install following dependancy: [ascii-image-converter](https://github.com/TheZoraiz/ascii-image-converter)

#### Homebrew

Installation with homebrew is available for both Linux and macOS.

```

brew install TheZoraiz/ascii-image-converter/ascii-image-converter

```

Check the other installation approaches in the dependency directory.



## Setup example

```shell

my-corporate-bash setup ./images.my_image.png -P 0.5 -C

```

#### Approximate proportion width image filling

```

[ terminal width ]

[-.........] -P 0.1

[--........] -P 0.2

[---.......] -P 0.3

[----......] -P 0.4

[-----.....] -P 0.5

[------....] -P 0.6

[-------...] -P 0.7

[--------..] -P 0.8

[---------.] -P 0.9

[----------] -P 1

--- image filling

... void filling

```

### Options

| Option     | Description                                                                                                             |

| ---------- | ----------------------------------------------------------------------------------------------------------------------- |

| -P _value_ | Sets the proportion of the terminal width used for displaying the image. The value must be between 0 (0%) and 1 (100%). |

| -C         | Retains the original colors of the source image. If not used, the image will be displayed in white.                     |

| -h, --help | Displays a help message.                                                                                                |

## Environments

| Tested | OS     | Version       | Architecture |

| ------ | ------ | ------------- | ------------ |

| ✅     | macOS  | 15.0 (24A335) | aarch64      |

| ❌     | Ubuntu | 20.04 LTS     | x86_64       |

| ❌     | WSL    | Ubuntu 20.04  | x86_64       |

## Troubleshooting

- Using -C but nothing shows : check your terminal client supports 24bits or 8bits colors