Tree [6c7837] main /
 History

Repo status: analyzing...

HTTPS access


File Date Author Commit
 .github 2021-06-01 Gourav Khator Gourav Khator [1716f4] Removed yamljs and json2yaml package for 1 pack...
 dist 2022-08-29 Gourav Khator Gourav Khator [6c7837] v1.3.3 builds
 docs 2022-08-29 Gourav Khator Gourav Khator [4bc82d] v1.3.2 builds
 project-images 2022-08-29 Gourav Khator Gourav Khator [6a3eaa] Updated the opacity field from deprecated backg...
 project-todos-and-research 2022-08-29 Gourav Khator Gourav Khator [6a3eaa] Updated the opacity field from deprecated backg...
 src 2022-08-29 Gourav Khator Gourav Khator [6a3eaa] Updated the opacity field from deprecated backg...
 tests 2022-08-28 Gourav Khator Gourav Khator [3eac33] Identified the bug for global/local bin command...
 .gitignore 2021-06-01 Gourav Khator Gourav Khator [4174ac] v1.3.1 builds
 CHANGELOG.md 2022-08-29 Gourav Khator Gourav Khator [6c7837] v1.3.3 builds
 LICENSE.md 2022-07-19 Gourav Khator Gourav Khator [b4246d] Updated License to use Apache-2.0 license
 README.md 2022-08-29 Gourav Khator Gourav Khator [9d213e] Solved bug for npm binary commands also working...
 package-lock.json 2022-08-29 Gourav Khator Gourav Khator [a044c5] 1.3.3
 package.json 2022-08-29 Gourav Khator Gourav Khator [a044c5] 1.3.3
 rollup.config.js 2022-08-29 Gourav Khator Gourav Khator [9d213e] Solved bug for npm binary commands also working...
 tsconfig.json 2022-08-28 Gourav Khator Gourav Khator [3eac33] Identified the bug for global/local bin command...

Read Me

Alacritty Auto Config

Apache

Check out the npm package in the npm repository here.

Download the stable release executables from SourceForge.net..

This is a small npm library, which helps you configure Alacritty with ease. It provides both the CLI options and the npm package, which can be used to extend its functionality in any project you create.

Usage Options

Executable's Demo

NPM Package Installation & Execution

Install the npm package

For windows users, please run the package to see if the configurations actually work or not. I am unable to test it out on windows platform.

Install the package globally:

npm install -g alacritty-auto-config

Note: Run the above command with sudo if you are on mac or linux

Install the package locally:

npm install alacritty-auto-config

Run the npm package binary in the CLI

Before running anything, make sure your alacritty.yml file (if it exists) is backed up, as it may overwrite some configurations in the alacritty.yml file as per your inputs in the CLI/API.

For global install:

alacritty-auto-config [options]=[values]

Or,

aac [options]=[values]

For local install of that npm package, just run the above commands on terminal prefixed with npm like mentioned below.

Ex-

npx alacritty-auto-config [options]=[values]
  • Show Help:
aac -h

Or,

aac --help
  • Options:
-s, --fontsize: Takes font size to be set in alacritty (default=10)
-b, --bgcolor: Takes primary background color in '#xxxxxx' or '#xxx' or '0xfff' or '0xffffff' format (default='#333333')
-c, --fgcolor: Takes primary foreground color in '#xxxxxx' or '#xxx' or '0xfff' or '0xffffff' format (default='#ffffff')
-t, --selcolor: Takes text color (when the area is selected) in '#ffffff' or '#fff' or '0xfff' or '0xffffff' format (default='#111122')
-y, --cursor: Takes cursor style that can be Block or Underline or Beam (default=Block)
-o, --opacity: Takes background opacity which is between 0.0 (transparent) and 1.0 (opaque) (default=1)
-v, --version: Show version number

Project Scripts

Install and Build the project

npm install
npm run build

Generate executables

npm run generate-binary

The generate-binary script will build the dist folder and generate the binary files for each major OS platforms. All the executables will be present in the dist/bin folder.

Run the development watch mode

This watch mode watches continuously for the typescript files

npm run dev

Extra Notes after you build this project yourself

The above options and values are also valid, if you build the project yourself, and run the output file with those options.

Run the below scripts from the project root folder:

node dist/esm/index.mjs [options]=[values]

Or,

node dist/cjs/index.cjs [options]=[values]

Supported NPM Package export types to be imported in your project

  • dist/cjs/index.cjs: CommonJS module.
  • dist/esm/index.mjs: EcmaScript module.
  • dist/esm/index.min.mjs: Minified EcmaScript module.
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.