mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-19 07:04:22 +01:00
e83782f5de
This PR: - adds all the guides (in markdown format) that is published at https://docs.corelightning.org/docs - adds a github workflow to sync any future changes made to files inside the guides folder - does not include API reference (json-rpc commands). Those will be handled in a separate PR since they're used as manpages and will require a different github workflow Note that the guides do not exactly map to their related files in doc/, since we reorganized the overall documentation structure on readme for better readability and developer experience. For example, doc/FUZZING.md and doc/HACKING.md#Testing are merged into testing.md in the new docs. As on the creation date of this PR, content from each of the legacy documents has been synced with the new docs. Until this PR gets merged, I will continue to push any updates made to the legacy documents into the new docs. If this looks reasonable, I will add a separate PR to clean up the legacy documents from doc/ (or mark them deprecated) to avoid redundant upkeep and maintenance. Changelog-None
24 lines
1.7 KiB
Markdown
24 lines
1.7 KiB
Markdown
---
|
|
title: "Plugin manager"
|
|
slug: "plugin-manager"
|
|
excerpt: "Learn how to add your plugin to the `reckless` plugin manager."
|
|
hidden: false
|
|
createdAt: "2023-02-08T13:22:17.211Z"
|
|
updatedAt: "2023-02-21T15:11:45.714Z"
|
|
---
|
|
`reckless` is a plugin manager for Core Lightning that you can use to install and uninstall [plugins](doc:plugins) with a single command.
|
|
|
|
To make your plugin compatible with reckless install:
|
|
|
|
- Choose a unique plugin name.
|
|
- The plugin entrypoint is inferred. Naming your plugin executable the same as your plugin name will allow reckless to identify it correctly (file extensions are okay).
|
|
- For python plugins, a requirements.txt is the preferred medium for python dependencies. A pyproject.toml will be used as a fallback, but test installation via `pip install -e .` - Poetry looks for additional files in the working directory, whereas with pip, any
|
|
references to these will require something like `packages = [{ include = "*.py" }]` under the `[tool.poetry]` section.
|
|
- Additional repository sources may be added with `reckless source add https://my.repo.url/here` however <https://github.com/lightningd/plugins> is included by default. Consider adding your plugin lightningd/plugins to make installation simpler.
|
|
- If your plugin is located in a subdirectory of your repo with a different name than your plugin, it will likely be overlooked.
|
|
|
|
> 📘
|
|
>
|
|
> As reckless needs to know how to handle and install the dependencies of a plugin, current version only supports python plugins. We are working on a broader support, e.g., for javascript, golang and other popular programming languages.
|
|
>
|
|
> Stay tuned and tell us what languages you need support for, and what features you're missing. |