Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/supitsdu/clipper

Seamlessly copy file contents to clipboard from command line. Lightweight, cross-platform tool for instant text transfers.
https://github.com/supitsdu/clipper

automation cli clipboard command-line-tool copy-to-clipboard developer-tools go utility

Last synced: 5 days ago
JSON representation

Seamlessly copy file contents to clipboard from command line. Lightweight, cross-platform tool for instant text transfers.

Awesome Lists containing this project

README

        

# Clipper - Ready to Paste

Clipper is a lightweight command-line tool written in Go for copying contents to the clipboard. Quickly and easily copy the contents of any file, command output, or even directly pass text to your clipboard inside your favorite terminal, streamlining your workflow and saving you time.

## Features ✨

- **Cross-Platform Compatibility:** Clipper works seamlessly on **Linux**, **macOS**, and **Windows**, providing consistent clipboard functionality across different operating systems.
- **Simple Usage:** With a straightforward command-line interface, Clipper makes it easy to copy file contents to the clipboard with just a single command.
- **Fast and Efficient:** Clipper is designed for performance and efficiency, allowing you to copy contents to the clipboard quickly and without unnecessary overhead.
- **Convenient:** Directly copy text, command output, or file contents to the clipboard consistently across all supported platforms.

## Installation

### Using the Install Script

You can install Clipper using the following command:

```sh
curl -sSL https://raw.githubusercontent.com/supitsdu/clipper/main/install.sh | sh
```

Or:

```sh
wget -qO- https://raw.githubusercontent.com/supitsdu/clipper/main/install.sh | sh
```

> [!NOTE]
> If you prefer not to use `curl ... | sh`, you can manually download and install Clipper as described below.

### Manual Installation

To use Clipper, download the appropriate binary for your operating system from the [releases page](https://github.com/supitsdu/clipper/releases) and place it in your desired location.

> [!IMPORTANT]
> Add the location of the binary to your system's PATH environment variable to access Clipper from anywhere on your system.

## Usage

Copy the contents of a file to the clipboard:

```shell
clipper ~/.ssh/id_ed25519.pub
```

Copy the output of any command:

```shell
go version | clipper
```

Directly copy text:

```shell
clipper -c "My awesome content!"
```

### Mimetype & Codeblock

![Code Snippet Preview](docs/assets/snippet-preview.png)

```shell
clipper -Mime -Markdown path/to/your-file.js
```

## Contributing 🤝

Contributions to Clipper are welcome! Here are a few ways you can contribute:

- **Report Bugs:** If you encounter any bugs or unexpected behavior while using Clipper, please [open an issue](https://github.com/supitsdu/clipper/issues) on GitHub to report it.
- **Request Features:** Have an idea for a new feature or improvement? [Open an issue](https://github.com/supitsdu/clipper/issues) to share your suggestion and start a discussion.
- **Submit Pull Requests:** If you're comfortable with Go programming, you can contribute directly to the development of Clipper by submitting pull requests. Fork the repository, make changes, and submit a pull request for review.

## Building from Source

To build Clipper from source, you'll need to have Go installed on your system and the Make tool.

### Requirements

- **Go Lang:** Clipper is written in Go, so you'll need Go installed on your system. You can download and install it from the [official Go website](https://golang.org/).
- **Make Tool:** Building Clipper from source requires the Make tool to automate the build process. Make is commonly pre-installed on Unix-like systems, but you may need to install it manually on Windows.

Once you have the requirements installed, clone the repository and run the following command in the project directory:

```sh
make
```

This command will build Clipper for Windows, Linux, and macOS inside the `bin` directory.

## License

Clipper is licensed under the [MIT License](LICENSE). Feel free to use, modify, and distribute it for any purpose.