{"id":15007437,"url":"https://github.com/arshadkazmi42/squash","last_synced_at":"2025-04-09T16:02:53.368Z","repository":{"id":52015239,"uuid":"162895272","full_name":"arshadkazmi42/squash","owner":"arshadkazmi42","description":"Squash your commands and give it a name :tada: :tada:","archived":false,"fork":false,"pushed_at":"2022-10-16T10:31:42.000Z","size":19261,"stargazers_count":14,"open_issues_count":4,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-09T16:01:31.298Z","etag":null,"topics":["alias","bash-comm","cli","commands","linux","mac","name","name-commands","shell-command","squash"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arshadkazmi42.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"arshadkazmi42"}},"created_at":"2018-12-23T13:56:54.000Z","updated_at":"2024-10-08T18:40:54.000Z","dependencies_parsed_at":"2023-01-20T08:48:45.872Z","dependency_job_id":null,"html_url":"https://github.com/arshadkazmi42/squash","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arshadkazmi42%2Fsquash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arshadkazmi42%2Fsquash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arshadkazmi42%2Fsquash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arshadkazmi42%2Fsquash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arshadkazmi42","download_url":"https://codeload.github.com/arshadkazmi42/squash/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065290,"owners_count":21041871,"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":["alias","bash-comm","cli","commands","linux","mac","name","name-commands","shell-command","squash"],"created_at":"2024-09-24T19:09:57.163Z","updated_at":"2025-04-09T16:02:53.336Z","avatar_url":"https://github.com/arshadkazmi42.png","language":"JavaScript","funding_links":["https://github.com/sponsors/arshadkazmi42"],"categories":[],"sub_categories":[],"readme":"# Squash :tada:\n\n[![Build](https://github.com/arshadkazmi42/squash/actions/workflows/nodejs.yml/badge.svg)](https://github.com/arshadkazmi42/squash/actions/workflows/nodejs.yml)\n[![NPM Downloads](https://img.shields.io/npm/dt/ak-squash.svg)](https://www.npmjs.com/package/ak-squash)\n[![Package Size](https://img.shields.io/bundlephobia/min/squash.svg)](https://www.npmjs.com/package/ak-squash)\n[![NPM Version](https://img.shields.io/npm/v/ak-squash.svg)](https://www.npmjs.com/package/ak-squash)\n[![Contributors](https://img.shields.io/github/contributors/arshadkazmi42/squash.svg)](https://github.com/arshadkazmi42/squash/graphs/contributors)\n[![Commit](https://img.shields.io/github/last-commit/arshadkazmi42/squash.svg)](https://github.com/arshadkazmi42/squash/commits/master)\n[![Node Version](https://img.shields.io/badge/node-v8.0%2B-brightgreen.svg)](https://github.com/arshadkazmi42/squash/)\n\n\u003cimg src=\"https://raw.githubusercontent.com/arshadkazmi42/squash/master/assets/squash.gif\" alt=\"Squash\"/\u003e\u003cbr\u003e\n\nLet's squash your commands.\n\nSquash allows you to give a custom name to your shell commands. These commands can be run using the custom name.\n\n\u003e Give us a :star: if you like our work :heart:\n\n## Install\n\n```\n$ npm i -g ak-squash\n```\n\n## Setup\n\n- **Export the squash path, to make the commands executable.**\n\n    `export PATH=$PATH:/usr/local/.squash`\n\n    To make this export permanent [read here](https://askubuntu.com/a/500794/579860)\n- Now try running `squash --help`. This should display details on using squash\n- This completes your setup\n\n## Usage\n\nOnce you are done with the setup. You can start giving custom names to your commands.\n\n\u003e You can find example usage of all the available features of squash [here](usage)\n\nSyntax for using squash is\n\n`squash {{COMMAND}} --alias={{NAME_FOR_COMMAND}}`\n\n- **COMMAND**: The shell command which will be given a name\n- **NAME_FOR_COMMAND**: The custom name\n\n**Note**: You can wrap the command between `\"COMMAND\"` if the command contains any types of quotes or spaces\n\n#### Example\n\n```\n$ squash ls /home/squash --alias=list_squash\n```\n\nNow for using above created command just run\n```\n$ list_squash\n```\n\n## Available Flags\n#### Flags that require parameters\n```\nsquash {{COMMAND}} --{{FLAG}}={{NAME_FOR_COMMAND}}\n```\n- **alias**: to give name to a command\n- **rm**: removes a previously squashed command\n#### Flags without parameters\n```\nsquash --{{FLAG}}\n```\n- **help**: gets help for squash\n- **list**: lists all the created commands\n- **system-alias**: lists all the system reserved aliases\n- **pass-args**: arguments called on the alias will be passed to the command. Use when creating the alias\n\n## Limitations\n\n- It does not work in Windows.\n- It does not support the `cd` command\n- **Manually exporting the path `/usr/local/.squash` is very important.**\n\n## Contributing\n\nWe are constantly working on improving squash and we need all the help we can get.\nYou can contribute to this project by giving [suggestions](https://github.com/arshadkazmi42/squash/issues/new), fixing open [issues](https://github.com/arshadkazmi42/squash/issues) or by implementing a new feature.\nRead our contibution guide [here](CONTRIBUTING.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farshadkazmi42%2Fsquash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farshadkazmi42%2Fsquash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farshadkazmi42%2Fsquash/lists"}