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

https://github.com/nobe4/gh-ln

Link files between repositories, from the command line.
https://github.com/nobe4/gh-ln

gh gh-cli gh-extension gh-extensions

Last synced: 5 months ago
JSON representation

Link files between repositories, from the command line.

Awesome Lists containing this project

README

          




Logo by @malohff

# `gh-ln`

> Link files between repositories.

> [!IMPORTANT]
> This project is under heavy development.

This action creates a _link_ between files in various places. When the source is
updated, the destination is as well.

It works by using the GitHub API to read files and create Pull Requests where an
update is needed. You can specify the source, destination, and schedule for the
synchronization.

> [!TIP]
> The authentication for this can be rather tricky, make sure you read
> [authentication](/docs/authentication.md) to get familiar with the various
> methods.

## Quickstart

1. Install `gh-ln`

```
gh extension install nobe4/gh-ln
```

1. Create a config file in `.ln-config.yaml`.

E.g. [`ln-config.yaml`](.ln-config.yaml)

1. Run

TODO

To use in Actions, see [nobe4/action-ln](https://github.com/nobe4/action-ln).

## Further readings

- [Authentication](/docs/authentication.md)
- [Configuration](/docs/configuration.md)