Skip to main content

Powerful Configurable Aliases

Project description

shortcut-alias

This is a personal project for configurable aliases.

As a personal project - there is no formal progression or documentation. I shall do my best to update this project, as I find issues with it, and add new features as I find needs.

Install

> pip install shortcut-alias

Usage

Shortcut-alias installs the following commands onto your system:

> shortcut-alias <command> <command_options>
> shortcut <command> <command_options>
> sa <command> <command_options>

First Run

On the first run, shortcut-alias will generate the needed file structure on first run, or on a new config directory.

By default the folder structure will be the following:

On Windows:

Name Filepath
root folder C:\Users\<username>\shortcut
settings C:\Users\<username>\shortcut\settings.yaml
commands folder C:\Users\<username>\shortcut\shortcut.d

On Linux:

Name Filepath
root folder ~\shortcut
settings ~\shortcut\settings.yaml
commands folder ~\shortcut\shortcut.d

To change this, set the environment variable "SHORTCUT_CONFIG".

Windows:

> $Env:SHORTCUT_CONFIG=<filepath>

Linux:

export SHORTCUT_COFNIG=<filepath>

settings.yaml

Please view docs/configuration.md for this.

shortcut.d files

Please view docs/shortcut_files.md for this.

Variables

Please view docs/variables.md for this.

Templating

Please view docs/templating.md for this.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shortcut-alias-0.2.6.tar.gz (15.1 kB view hashes)

Uploaded Source

Built Distribution

shortcut_alias-0.2.6-py3-none-any.whl (17.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page