Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ololx/create-symlink

Create Symlink is a simple mac Automator workflow which provides a GUI for the symbolic links creation on macOS. There is an alternative https://github.com/ololx/quick-symlink
https://github.com/ololx/create-symlink

automator-workflow finder-extension macos macos-app macos-application macos-applications macos-automator open-source symbolic-links symlink workflow

Last synced: about 2 months ago
JSON representation

Create Symlink is a simple mac Automator workflow which provides a GUI for the symbolic links creation on macOS. There is an alternative https://github.com/ololx/quick-symlink

Awesome Lists containing this project

README

        



Stars earned


discutions

# Create Symlink

The Create Symlink is a simple mac Automator workflow which provides a GUI for the symbolic links creation on macOS.

[![tag](https://img.shields.io/github/v/tag/ololx/create-symlink?style=flat&include_prereleases&logo=github)](https://github.com/ololx/create-symlink/tags) [![release](https://img.shields.io/github/v/release/ololx/create-symlink?style=flat&include_prereleases&logo=github)](https://github.com/ololx/create-symlink/releases)

[![osslifecycle](https://img.shields.io/osslifecycle/ololx/create-symlink?style=flat)](OSSMETADATA) [![last_commit](https://img.shields.io/github/last-commit/ololx/create-symlink?style=flat&logo=github)](https://github.com/ololx/create-symlink/commits) [![release_date](https://img.shields.io/github/release-date/ololx/create-symlink?style=flat&logo=github)](https://github.com/ololx/create-symlink/releases)

[![licence](https://img.shields.io/github/license/ololx/create-symlink?style=flat)](LICENCE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=flat)](CODE_OF_CONDUCT.md)

![repo_size](https://img.shields.io/github/repo-size/ololx/create-symlink?style=flat&logo=github)

![platform](https://img.shields.io/badge/platform-OS_X_10.10+-important?style=flat)

---

## πŸ“‡ Table of Contents

- [About](#about)
- [Demo](#demo)
- [Features](#feature)
- [Getting Started](#getting-started)
- [Built With](#built-with)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Versioning](#versioning)
- [Authors](#authors)
- [Licensing](#licensing)

## πŸ“– About

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.
Create Symlink is a mac Automator workflow which allows to create symbolic links of selected folders or files. It can be added to the "Services” menu and called by right-clicking on selected folders or files and selecting `Services --> create symlink` from the context menu.

**There is an alternative project with similar functionality, but a different implementation - a `Finder extension`.; for more details see https://github.com/ololx/quick-symlink.**

## πŸ“Έ Demo

Demo shows how it works.

![create symlink](resources/demo/demo-create-symlink.gif)

## 🎚 Features

- Create a symbolic links in a several clicks via the context menu instead of the terminal promt;
- Create a symbolic links for the selected files or folders;
- Save a symbolic links to the selected directory.

### To Do

- ~~For more information on an upcoming development, please read the todo list.~~ No plans.

### Changelog

- For more information on a releases, a features and a changes, please read the [changelog](CHANGELOG.md) 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:

- **[macOS](https://www.apple.com/ru/macos/what-is/)** - the operating system under which the process is executing;
- **[Automator](https://support.apple.com/guide/automator/welcome/mac)** - the program for operations automation.

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

1. #### macOS
- Install macOS by [this](https://support.apple.com/ht201372) instruction.

2. #### Automator

- Automator is included on macOS. Just install the macOS.

### Installing

In order to install it is quite simple to:

1. Clone this repository;

2. Go to the directory with this tool (optionally):

- via Finder;
- via Terminal prompt;

```bash
cd /{path to dir with tool}/create-symlink
```

3. Install the tool in macOS (optionally):

- via double-click on _create symlink.workflow_;
- via Terminal prompt;

```bash
open create\ symlink.workflow
```
4. Push the `Install` button.

### Cloning

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

```bash
https://github.com/ololx/create-symlink
```

### Using

For use it is required to:

1. Select folders or files for which a symbolic link is needed;
2. Call the context menu by right-clicking on selected;
3. Select menu item `services --> create symlink`;
4. Select a destination folder on the choosing dialog and push the `Select` button.

## πŸ›  Built With

- **[Automator](https://support.apple.com/guide/automator/welcome/mac)** - the program for operations automation.

## πŸŽ‰ Contributing

If you want to contribute this project - you are welcome and have fun.
Please visit the [contributing](CONTRIBUTING.md) 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](CODE_OF_CONDUCT.md).

## πŸ—’ Versioning

For the versioning is used [Semantic Versioning](http://semver.org/). For the versions available, see the [changelog](CHANGELOG.md) or the tags on this repository.

## ©️ Authors

* **Alexander A. Kropotin** - *Initial work* - [ololx](https://github.com/ololx).

## πŸ” Licensing

This project is licensed under the MIT license - see the [lisence](LICENSE) document for details.