{"id":18057226,"url":"https://github.com/m4cs/aly","last_synced_at":"2025-06-22T07:36:41.649Z","repository":{"id":57644241,"uuid":"322142703","full_name":"M4cs/aly","owner":"M4cs","description":"Command Line Alias Manager and Plugin System - Written in Golang","archived":false,"fork":false,"pushed_at":"2020-12-23T19:13:42.000Z","size":9173,"stargazers_count":21,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-25T02:43:46.445Z","etag":null,"topics":["aliases","bash","batch","cross-platform","golang","shell"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/M4cs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-17T01:08:49.000Z","updated_at":"2022-06-16T10:28:59.000Z","dependencies_parsed_at":"2022-08-30T04:51:33.175Z","dependency_job_id":null,"html_url":"https://github.com/M4cs/aly","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M4cs%2Faly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M4cs%2Faly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M4cs%2Faly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M4cs%2Faly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/M4cs","download_url":"https://codeload.github.com/M4cs/aly/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248345275,"owners_count":21088242,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aliases","bash","batch","cross-platform","golang","shell"],"created_at":"2024-10-31T02:07:06.097Z","updated_at":"2025-04-11T04:40:46.216Z","avatar_url":"https://github.com/M4cs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca align=\"center\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/M4cs/aly/master/aly-logo.png\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# aly - Command Line Alias Manager and Packager\n\nAly offers the simplest way to manage, share, and obtain command line aliases!\n\nWarning: This project is still in early development. Minimal testing has been done on Windows!\n\n### Table of Contents\n\n#### I. [Features](https://github.com/M4cs/aly#features)\n#### II. [Installation](https://github.com/M4cs/aly#installation)\n#### III. [Usage](https://github.com/M4cs/aly#usage)\n  - [Installing A Plugin](https://github.com/M4cs/aly#installing-a-plugin)\n  - [Enabling/Disabling Plugins](https://github.com/M4cs/aly#enablingdisabling-plugins)\n  - [Updating Plugins](https://github.com/M4cs/aly#update-plugins)\n  - [Listing Plugins](https://github.com/M4cs/aly#see-all-installed-plugins)\n  - [See Plugin Info](https://github.com/M4cs/aly#see-plugin-info)\n  - [Deleting Plugins](https://github.com/M4cs/aly#delete-a-plugin-completely)\n#### IV. [Creating Plugins](https://github.com/M4cs/aly#creating-a-plugin)\n#### V. [Adding an Official Plugin](https://github.com/M4cs/aly#adding-your-plugin-to-the-official-repository)\n\n## Features\n\n- Aliases shared, loaded, and stored as JSON files for easy customization and readability\n- Configure w/ the tool or manually\n- Download remote Alias plugins to load a bunch all at once!\n- Update plugins remotely or from local files!\n\n## Installation\n\nFirst, install Go and then run:\n\n```\ngo get -u github.com/M4cs/aly\ngo install github.com/M4cs/aly\n```\n\nNext, add this to your shell's profile:\n\n```\naly -l\nsource ~/.alyases\n```\n\nSee below for usage information!\n\n## Usage\n\n### Installing a Plugin\n\n```\n# From Remote URL\naly -a 'https://raw.githubusercontent.com/M4cs/aly/master/example_unix_plugin.json'\n\n# From Local File\naly -a '/path/to/plugin.json' -f\n\n# Enable the plugin\naly -e 'Plugin Name'\n```\n\n### Enabling/Disabling Plugins\n\n```\n# Enable\naly -e 'Plugin Name'\n\n# Disable\naly -d 'Plugin Name'\n```\n\n### Update Plugins\n\n```\n# Update A Single Plugin from their URL\naly -u 'Plugin Name'\n\n# Update A Single Plugin from Local File\naly -u '/path/to/plugin.json' -f\n\n# Update All Plugins\naly -t\n```\n\n### See All Installed Plugins\n\n```\naly -i\n```\n\n### See Plugin Info\n\n```\naly -p 'Plugin Name'\n```\n\n### Delete A Plugin Completely\n\n```\naly -r 'Plugin Name'\n```\n\n## Creating a Plugin\n\nAll plugins are in the JSON format. You can create a plugin very easily using the below formatting.\n\n```json\n{\n    \"plugin_name\": \"Your Plugin Name\",\n    \"author\": \"github/M4cs\",\n    \"description\": \"A small description about your plugin\",\n    \"version\": \"1.0.0\",\n    \"aliasmap\": [\n        {\n            \"alias\": \"ec\",\n            \"description\": \"Example Alias\",\n            \"command\": \"echo\",\n            \"platform\": \"*\",\n            \"subalias\": {\n                \"t\": \"'testing'\",\n                \"hw\": \"'hello, world!'\",\n                \"a\": \"$1\"\n            } \n        }\n    ]\n}\n```\n\n### Top-Level\n\n- **plugin_name** - The name of your plugin. This is what it will be referred to for updating, enabling, disabling, etc. Keep it short and unique!\n- **author** - Your name. I recommend using your github/USERNAME\n- **description** - A small description about your plugin\n- **version** - Version number for plugin. This should be semantic syntax.\n- **aliasmap** - Your map of aliase groups for the plugin.\n- **platform** - Refers to the platform that the alias will work on. Supports: `windows`, `unix`, `*`, or any [GOOS](https://gist.github.com/asukakenji/f15ba7e588ac42795f421b48b8aede63) platforms.\n\n#### aliasmap\n\nAn alias group includes a base alias, base command, and subaliases. If there are subaliases, they will be concatenated with the base alias.\n\n- **alias** - The base alias for your command. This will run whatever is in `command`.\n- **command** - The base command for your alias. This will run whenever the `alias` is run.\n- **description** - Description of your alias group.\n- **subaliases** - subalias:args dictionary. This will add the `subalias` to the `alias` specified and add the `args` string to your base `command` string.\n\nUsing the JSON example above:\n\n- `ec` will run `echo`\n- `ect` will run `echo 'testing'`\n- `echw` will run `echo 'hello, world!'`\n- `eca` will run `echo $1` using whatever argument you send to it (or Windows equivalent)\n\n## Adding Your Plugin To The Official Repository\n\nYou should add a folder with your username into `./official_plugins/`. For example, I'd add `./official_plugins/M4cs/`. Inside of this folder, you will add your different plugins using `.json` files. You should include a `README.md` with some information about what your plugin(s) offer!\n\n1. Make a Pull Request using the `Add a Plugin` Template [Here]()\n2. Fill Out Pull Request Template w/ Your Fork\n3. Submit Pull Request and Await Review!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm4cs%2Faly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm4cs%2Faly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm4cs%2Faly/lists"}