Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vaulty) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Vaulty

Vaulty is a lightweight CLI command storage tool that helps you save and retrieve commands effortlessly. Built in Rust with a focus on simplicity and efficiency. 🚀

Demo

Github Release NPM Downloads

Features

Store and retrieve frequently used commands
Organize commands with descriptions
Interactive prompts for adding, picking, and deleting commands
Searchable list for quick access 🔍
Copies selected commands to the clipboard
Simple and fast CLI interface
Built-in help for all commands

Installation

Install via npm

You can install Vaulty globally using npm:

npm i -g vaulty

For now, NPM is only supported on Windows.

Build from Source

You can build Vaulty from source, to your own platform (linux, macos...) following these steps:

# Clone the repository
git clone https://github.com/yourusername/vaulty.git
cd vaulty

# Build the project
cargo build --release

# Run Vaulty
./target/release/vaulty # On terminal

Usage

Vaulty stores commands in a JSON file located in the AppData/vaulty folder.

Commands

Save a command (`save` or `add`)

vaulty save -c "git commit -m 'your message'" -d "Commit with message"

If no arguments are passed, an interactive prompt will guide you through adding a command.

List stored commands (`list` or `ls`)

vaulty list

Displays a table with all stored commands and their descriptions.

Pick a command to copy to clipboard (`pick` or `copy`/`cp`)

vaulty pick

Shows an interactive searchable list to pick a command, which is then copied to the clipboard. 📋

Delete a command (`delete`, `del`, or `rm`)

vaulty delete <command_id>

If no ID is provided, an interactive list will allow you to select a command for deletion.

Help (`help`)

vaulty help

Shows help for all commands. You can also use:

vaulty <command> help

to get detailed help for a specific command. ❓

Dependencies

Rust (language)
Inquire (interactive prompts)
Tabled (table rendering)

Planned Features

Sync with Pastebin for command sharing
Import/export commands
Bulk insert or delete commands from input files or CLI

Contributing

We welcome contributions! To contribute:

Fork the repository
Create a new branch (git checkout -b feature-branch)
Commit your changes (git commit -m 'Add feature')
Push to the branch (git push origin feature-branch)
Open a Pull Request

License

Vaulty is licensed under the MIT License.

Contact

For questions or suggestions, feel free to open an issue or reach out on my socials that you can find on ricardo.gg 😊

vaulty