Skip to main content

A CLI tool for managing code snippets

Project description

Here’s the README.md file as a text block for your "Snippy" project:

📝 Snippy - A Simple CLI for Managing Code Snippets

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.

🚀 Features

  • 📂 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.

📦 Installation

To install Snippy, follow these steps:

  1. Clone the repository:

    git clone https://github.com/TejasBaid/snippy-cli.git
    cd snippy-cli
    
  2. Install the package:

    pip install .
    

Note: Make sure you have Python 3.x and pip installed.

🛠️ Usage

Once installed, Snippy can be used directly from the terminal using the snip command.

Example Commands:

  • 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
    

📖 Available Commands

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

🤝 Contributing

Feel free to submit pull requests, open issues, or suggest new features! Contributions are welcome.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements

  • Thanks to the open-source community for the inspiration and support.

You can directly copy and paste this into your `README.md` file for your GitHub repository. Let me know if you need any further changes!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

snippy_cli-1.0.0-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file snippy_cli-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: snippy_cli-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for snippy_cli-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 10e5fbf7265edafee1ea7d7347a0f1f86f8d7e6f0778059348cc06e8a3db4119
MD5 03eb4a7400ab479df45eaef8963a302d
BLAKE2b-256 1f7f0d00659a1523854156a33d5a947ad99a7f88d18c9fa3b22f646fb79f1d3a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page