Here’s the updated README.md file with the primary installation method set as PyPI and the manual installation as a secondary option. I’ve updated the links accordingly:
Snippy is a lightweight command-line interface (CLI) tool for managing code snippets efficiently. With Snippy, you can create, edit, copy, and delete snippets right from your terminal. It's designed to help developers quickly store and retrieve useful code snippets, all while keeping things simple and straightforward.
- 📂 Create, list, and manage snippets easily.
- ✏️ Open snippets in your preferred text editor.
- 📋 Copy snippets directly to the clipboard.
- 🗑️ Delete snippets when they are no longer needed.
The easiest way to install Snippy is from PyPI. Just run the following command:
pip install snippy-cliThis will install snippy-cli and its dependencies, making it available as a command-line tool that you can run directly.
If you prefer to install manually, you can clone the repository and install the package locally.
-
Clone the repository:
git clone https://github.com/TejasBaid/snippy-cli.git cd snippy-cli -
Install the package:
pip install .
Note: Make sure you have Python 3.x and
pipinstalled.
Once installed, Snippy can be used directly from the terminal using the snip command.
-
Create a new snippet:
snip create my_snippet
This command opens your default text editor to create a snippet. The snippet will be saved in the
Snippets/directory. -
List all snippets:
snip list
-
Open a snippet for editing:
snip open my_snippet
-
Copy a snippet to the clipboard:
snip copy my_snippet
-
Delete a snippet:
snip delete my_snippet
-
Display help:
snip help
| Command | Description |
|---|---|
snip create <snippet_name> |
Create a new snippet |
snip list |
List all snippets |
snip open <snippet_name> |
Open an existing snippet for editing |
snip copy <snippet_name> |
Copy the snippet's content to the clipboard |
snip delete <snippet_name> |
Delete a snippet |
snip help |
Display this help message |
This is snippy-cli v1.0.0, which includes the following features:
- Snippet management: Create, list, open, edit, copy, and delete snippets from the command line.
- Clipboard functionality: Easily copy snippet content to your clipboard.
- Interactive mode (planned for future versions).
Stay tuned for more updates in future versions!
Feel free to submit pull requests, open issues, or suggest new features! Contributions are welcome. To contribute:
- Fork the repository.
- Create a new feature branch (
git checkout -b feature-branch). - Make your changes and commit (
git commit -m "Add some feature"). - Push to the branch (
git push origin feature-branch). - Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
- Thanks to the open-source community for the inspiration and support.
### Key Changes:
- **Primary installation**: I set the **PyPI** installation as the recommended method with the provided link: [https://pypi.org/project/snippy-cli/](https://pypi.org/project/snippy-cli/).
- **Manual installation**: I moved the repository clone and local installation to a secondary, optional section.
This structure should now clearly guide users to install from PyPI, while still offering a manual installation method if needed.
Let me know if any other adjustments are needed!