# quickcmd

> quickcmd is a CLI tool for managing and accessing frequently used commands easily.

Latest version **1.1.0** (published 2025-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install quickcmd
pnpm add quickcmd
yarn add quickcmd
bun add quickcmd
```

Provides the command `qk`.

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2025-07-05 |
| First published | 2024-04-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 53.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Somya Bhatt |
| Maintainers | shanksxxz |
| Keywords | cli, command-line, commands, management, productivity, workflow, terminal, developer, sysadmin |

## Links

- npm: https://www.npmjs.com/package/quickcmd
- Repository: https://github.com/shanksxz/quickcmd
- Homepage: https://github.com/shanksxz/quickcmd#readme
- Issues: https://github.com/shanksxz/quickcmd/issues
- npm.io page: https://npm.io/package/quickcmd

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^5.4.1
- [commander](https://npm.io/package/commander.md) ^13.1.0
- [@clack/prompts](https://npm.io/package/@clack/prompts.md) ^0.10.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2025-07-05
- 1.0.8 — 2025-05-12
- 1.0.7 — 2025-04-09
- 1.0.6 — 2024-05-17
- 1.0.5 — 2024-05-12
- 1.0.4 — 2024-05-09
- 1.0.3 — 2024-05-06
- 1.0.2 — 2024-05-04
- 1.0.1 — 2024-05-04
- 1.0.0 — 2024-04-24

## README

# quickcmd ⚡

quickcmd is a command-line interface (CLI) tool that helps you save and manage your frequently used shell commands. It provides a convenient way to store, retrieve, search, and execute commands, making your workflow faster and more efficient, all from your terminal.

## Installation

To get started with `quickcmd`, install it globally using your preferred package manager:

```bash
# Using npm
npm install -g quickcmd

# Using pnpm
pnpm install -g quickcmd

# Using bun
bun install -g quickcmd
```

## Initial Setup

After installation, run the `init` command to create the necessary directory and files for storing your commands. This only needs to be done once.

```bash
qk init
```

## Commands

`quickcmd` uses an intuitive subcommand structure. Here is a complete list of available commands:

| Command           | Alias | Description                                                 |
| ----------------- | ----- | ----------------------------------------------------------- |
| `qk init`         |       | Initializes the storage directory.                          |
| `qk list`         | `ls`  | Lists all saved command groups by title.                    |
| `qk add`          |       | Adds a new command to a specified group.                    |
| `qk get <title>`  |       | Displays all commands within a specific group.              |
| `qk run <title>`  |       | Interactively select and execute a command from a group.    |
| `qk edit <title>` |       | Edits an existing command in a group.                       |
| `qk remove <title>` | `rm`  | Interactively removes commands from a group.                |
| `qk search <query>` |       | Searches for commands by title or content.                  |
| `qk import <path>`  |       | Imports commands from a JSON file and merges them.          |
| `qk export <path>`  |       | Exports all saved commands to a JSON file.                  |
| `qk path`         |       | Displays the path to the storage file.                      |

## Usage Examples

### Adding a Command

Save a new command under a group title. If the group doesn't exist, it will be created.

```bash
❯ qk add -t "docker" -c "docker-compose up -d"
✔ Command saved successfully.
```

### Listing all Command Groups

See all the groups you have saved.

```bash
❯ qk list
Available command titles:
- git
- docker
- npm
```

### Running a Command

Select a group title to see its commands, then choose one to execute immediately.

```bash
❯ qk run git
✔ Select a command to run › - Use arrow-keys. Return to submit.
│   git status
│   git push
└   git pull --rebase
```

### Searching for a Command

Find a command when you can't remember the group.

```bash
❯ qk search "commit"
✔ Found 2 matching commands for "commit":

git
- git commit -m "feat: initial commit"

github
- gh release create v1.0.0
```

### Import & Export

Backup your commands or share them with your team.

```bash
# Export to a file
qk export ./my_commands.json

# Import from a file
qk import ./my_commands.json
```

## Data Storage

Your commands are stored in a simple JSON file located in your user home directory. To find the exact location, run:

```bash
qk path
```

The data structure looks like this:

```json
[
  {
    "title": "git",
    "commands": ["git status", "git push"]
  }
]
```

## Contributing

Contributions are welcome! If you find any issues or have ideas for improvements, please open an issue or submit a pull request on the GitHub repository.

For more detailed information on how to contribute, please see our [Contributing Guide](./CONTRIBUTING.md).

---
_Source: https://npm.io/package/quickcmd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._