Skip to content

SnipEditor/snip

Repository files navigation

Snip

Snip is a simple, cross-platform text editor inspired by Boop. It aims to improve on Boop by adding cross-platform support, better handling of large files, enhanced syntax highlighting, and the ability to operate on files. Snip maintains a focus on easy scripting, quick startup, and usefulness as a small notepad for copying and editing snippets.

Features

  • Cross-Platform Support: Available on macOS, Windows, and Linux.
  • Handling of Large Files: Efficiently handles large files without performance degradation.
  • Syntax Highlighting: Syntax highlighting for various programming languages.
  • File Operations1: Ability to open, edit, and save files.
  • Easy Scripting: Simple and powerful scripting capabilities.
  • Quick Startup: Fast startup time, making it ideal for quick edits.
  • Notepad Functionality: Useful as a small notepad for copying and editing snippets.

Screenshots

Screenshot 1 Screenshot 2

Installation

macOS

Download the .dmg from the releases page. Open the archive and move the Snip application to your 'Applications' folder.

Note

Opening the archive or opening the application for the first time requires you to open through the context menu in finder, since the application is signed but not notarized

Windows

Download the .msi for your cpu architecture from the releases page. Open it and follow the installation instructions.

Linux

Debian-based operating systems

Download the .deb for your cpu architecture from the releases page. Run the following command with <file> replaced with the path to the downloaded .deb file:

sudo dpkg -i <file>

Red Hat based operating systems

Download the .rpm for your cpu architecture from the releases page. Run the following command with <file> replaced with the path to the downloaded .rpm file:

sudo rpm -i <file>

Usage

To start Snip, simply run it from your application list

Building from Source

Prerequisites

  • Rust
  • Cargo
  • Node.js
  • Yarn

Steps

  1. Clone the repository:

    git clone /~https://github.com/SnipEditor/snip.git
    cd snip
  2. Install dependencies:

    yarn install
  3. Run the application in development mode:

    yarn tauri dev
  4. (To build a standalone executable):

    yarn tauri build

License

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

Acknowledgements

Footnotes

  1. Not yet supported, but coming soon