https://github.com/kingdevnl/symlinkme
https://github.com/kingdevnl/symlinkme
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kingdevnl/symlinkme
- Owner: kingdevnl
- Created: 2023-04-02T09:22:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-03T15:14:18.000Z (about 3 years ago)
- Last Synced: 2025-10-06T13:38:12.333Z (8 months ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# symlinkme
`symlinkme` is a command-line tool that makes it easy to create symbolic links in your project directory. With `symlinkme`, you can quickly and easily create links between files and directories, which can be useful for sharing files between different projects or linking to common files.
## Installation
To use `symlinkme`, you must have Node.js and npm installed on your system. You can then install `symlinkme` using npm:
npm install -g symlinkme
## Usage
To create a symbolic link using `symlinkme`, simply navigate to the directory where you want to create the link and run the following command:
symlinkme
Where `` is the file or directory you want to link to, and `` is the name of the link you want to create. For example, to link the `.env` file in the root directory to a new file named `.env` in the `hello` directory, run the following command:
symlinkme .env hello/.env
This will create a new symbolic link named `.env` in the `hello` directory that points to the `.env` file in the root directory.
## Options
TODO: Add options, (force, version)
## License
`symlinkme` is open source software released under the [MIT license](https://opensource.org/licenses/MIT).
## Contributing
If you'd like to contribute to `symlinkme`, feel free to submit a pull request or open an issue on the [GitHub repository](https://github.com/kingdevnl/symlinkme). We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code changes.