Skip to content

Latest commit

 

History

History
237 lines (160 loc) · 10.7 KB

README.md

File metadata and controls

237 lines (160 loc) · 10.7 KB
Raw

Quick Symlink

The Quick Symlink is a Finder extension which provides a contextual menu item for the symbolic links (and other links) creation on macOS.

tag release

osslifecycle last_commit release_date

licence Contributor Covenant FOSSA Status

repo_size languages_code_size languages_count languages_top

platform

📇 Table of Contents

📖 About

The Quick Symlink is a Finder Extension which allows to create symbolic links of selected folders or files. It could be called by right-clicking on selected folders or files and selecting Quick Symlink from the contextual menu. It is a remaster of the other project - create-symlink; for more details see https://github.com/ololx/create-symlink.

Motivation

For me the symbolic links is a useful feature of macOS. They can be especially useful when it's needed to store the Documents folder on a hard drive or SD card, but on the ssd to create a just link to this folder. Of course, creating symbolic links via the terminal is very easy and convenient. But this does not negate the fact that it could be even easier and more comfortable through interaction with the GUI.

📸 Demo

This GIF demonstrates how the Quick Symlink allows quite simple to select files or folders and paste symlink in the current directory.

This GIF demonstrates how the Quick Symlink allows quite simple to copy files or folders and paste symlink somewhere.

This GIF demonstrates how the Quick Symlink allows quite simple to copy files or folders, paste them somewhere, and replace them with symlinks.

These GIFs demonstrate the `Quick Symlink` localization.

🎚 Features

  • Create a symbolic links in a several clicks via the context menu instead of the terminal promt:

    • Select files or folders and create symlinks for them.
    • Copy files or folders and paste symlinks somewhere.
    • Copy files or folders, paste them somewhere, and replace them with symlinks.

  • Create a hard links in a several clicks via the context menu instead of the terminal promt:

    • Select files or folders and create hard links for them.
    • Copy files or folders and paste hard links somewhere.

To Do

  • For more information on an upcoming development, please read the todo list.

Changelog

  • For more information on releases, features and changes, please read the changelog notes.

🚦 Getting Started

These instructions allow to get a copy of this project and run it on a local machine.

Prerequisites

Before using it, make sure that follows software are installed on the local machine:

  • OS X 10.10+ - the operating system under which the extention is executing.

If any of the listed programs is not installed, then it can be installed by instruction as described below.

  1. OS X 10.10+

    • Install macOS 10.10+ by this instruction.

Installing

In order to install it is quite simple to:

  1. Download executable file from releases (or compile it from the sources).

  2. Go to the directory where you download this tool (optionally):

    • via Finder.
    • via Terminal prompt.
    cd /{path to parent dir with this tool}/

  3. Launch the tool in macOS (optionally):

    • via double-click on quick-symlink.app.
    • via Terminal prompt.
    open quick-symlink.app

  4. Open up System Preferences > Extensions and enable the follows extensions: 4.1. quick-symlink-extension - for the symlink actions. 4.2. hard-link-actions-extension - for the hard link actions.

Otherwise, it's possible to install and remove the extention using the actual extension bundled into the app.

  1. To install and approve the extension, run this:
pluginkit -a quick-symlink.app/Contents/PlugIns/quick-symlink-extension.appex/
pluginkit -a quick-symlink.app/Contents/PlugIns/hard-link-action-extension.appex/
  1. To remove it, run this:
pluginkit -r quick-symlink.app/Contents/PlugIns/quick-symlink-extension.appex/
pluginkit -r quick-symlink.app/Contents/PlugIns/hard-link-action-extension.appex/
  1. [OPTIONAL] Check/Uncheck the checkbox on the Application window "Use relative path for symlink" to use the relative path instead absolute path for the creating symlinks. By default it's enabled

Downloading

For the downloading executable file or sources to a local machine, just use the follows link and choose a required release:

https://github.com/ololx/quick-symlink/releases/

Cloning

For the cloning this repository to a local machine, just use the follows link:

https://github.com/ololx/quick-symlink.git

Using

This tool allows to:

Create symlinks in the current directory 1. Select folders or files for which a symbolic link is needed.
2. Call the contextual menu by the right-clicking on selected.
3. Select menu item `Symlink actions --> Create symlink for`.
Create symlinks in another directory 1. Select folders or files for which a symbolic link is needed.
2. Call the contextual menu by the right-clicking on selected.
3. Select menu item `Symlink actions --> Copy path from here`.
4. Go to a destination folder.
5. Call the contextual menu by right-clicking on the filder.
6. Select menu item `Symlink actions --> Paste to here`.
Replace objects with symbolic links 1. Select folders or files for which a symbolic link is needed.
2. Call the contextual menu by the right-clicking on selected.
3. Select menu item `Symlink actions --> Copy to clipboard`.
4. Go to a destination folder.
5. Call the contextual menu by right-clicking on the filder.
6. Select menu item `Symlink actions --> Move it here and replace with a link`.
Create hard links in the current directory 1. Select folders or files for which a symbolic link is needed.
2. Call the contextual menu by the right-clicking on selected.
3. Select menu item `Hard link actions --> Create symlink for`.
Create symlinks in another directory 1. Select folders or files for which a symbolic link is needed.
2. Call the contextual menu by the right-clicking on selected.
3. Select menu item `Hard link actions --> Copy path from here`.
4. Go to a destination folder.
5. Call the contextual menu by right-clicking on the filder.
6. Select menu item `Hard link actions --> Paste to here`.

🛠 Built With

  • Xcode - the IDE for the Finder Sync Extension development.

🎉 Contributing

If you want to contribute this project - you are welcome and have fun. Please visit the contributing section for details on this code of conduct, and the process for submitting pull requests.

📝 Code of Conduct

In order to ensure that all is welcoming, please review and abide by the code of conduct.

🗒 Versioning

For the versioning is used Semantic Versioning. For the versions available, see the changelog or the tags on this repository.

©️ Authors

  • Alexander A. Kropotin - Initial work - ololx.

🔏 Licensing

This project is licensed under the MIT license - see the lisence document for details.

FOSSA Status