# Core Lightning Documentation

> Documentation for Core Lightning

## Guides
- [Welcome to Core Lightning Documentation Portal](https://docs.corelightning.org/docs/home.md): Here you can find everything you need to jump-start your journey to running and building on Core Lightning.
- [Set up your node](https://docs.corelightning.org/docs/getting-started.md): This guide will help you set up a Core Lightning node. You'll be up and running in a jiffy!
- [Installation](https://docs.corelightning.org/docs/installation.md): Core lightning is available on many platforms and environments. Learn how to install on your preferred platform.
- [Configuring your node](https://docs.corelightning.org/docs/configuration.md): Choose from a variety of configuration options as per your needs.
- [Upgrade](https://docs.corelightning.org/docs/upgrade.md): Upgrade to the latest stable releases without interruption.
- [Reproducible builds](https://docs.corelightning.org/docs/repro.md)
- [Using Tor](https://docs.corelightning.org/docs/tor.md)
- [Bitcoin Core](https://docs.corelightning.org/docs/bitcoin-core.md)
- [Running your node](https://docs.corelightning.org/docs/beginners-guide.md): A guide to all the basics you need to get up and running immediately.
- [Opening channels](https://docs.corelightning.org/docs/opening-channels.md)
- [Sending and receiving payments](https://docs.corelightning.org/docs/sending-and-receiving-payments.md)
- [Securing keys](https://docs.corelightning.org/docs/securing-keys.md)
- [Backup your wallet](https://docs.corelightning.org/docs/backup.md): Learn the various backup options available for your Core Lightning node.
- [HSM Secret](https://docs.corelightning.org/docs/hsm-secret.md): Learn about various cool HSM secret methods.
- [Advanced DB Backup](https://docs.corelightning.org/docs/advanced-db-backup.md): Learn the various DB backup techniques.
- [Wallet recovery](https://docs.corelightning.org/docs/recovery.md): Learn about various recovery methods.
- [Watchtowers](https://docs.corelightning.org/docs/watchtowers.md): Defend your node against breaches using a watchtower.
- [Analytics](https://docs.corelightning.org/docs/analytics.md): Analyse your node data for effective node management.
- [Plugins](https://docs.corelightning.org/docs/plugins.md): Leverage a plethora of plugins on Core Lightning.
- [Troubleshooting & FAQ](https://docs.corelightning.org/docs/faq.md): Common issues and frequently asked questions on operating a CLN node.
- [Setting up a dev environment](https://docs.corelightning.org/docs/developers-guide.md): Get up and running in your local environment with essential tools and libraries in your preferred programming language.
- [App Development](https://docs.corelightning.org/docs/app-development.md): Build a lightning application using Core Lightning APIs.
- [JSON-RPC commands](https://docs.corelightning.org/docs/json-rpc.md)
- [REST APIs](https://docs.corelightning.org/docs/rest.md)
- [gRPC APIs](https://docs.corelightning.org/docs/grpc.md)
- [WSS Proxy](https://docs.corelightning.org/docs/wss-proxy.md)
- [Commando Plugin](https://docs.corelightning.org/docs/commando-plugin.md)
- [Third-party libraries](https://docs.corelightning.org/docs/third-party-libraries.md)
- [Plugin Development](https://docs.corelightning.org/docs/plugin-development.md): Customise your Core Lightning node by leveraging its powerful modular architecture via plugins.
- [A day in the life of a plugin](https://docs.corelightning.org/docs/a-day-in-the-life-of-a-plugin.md)
- [JSON-RPC passthrough](https://docs.corelightning.org/docs/json-rpc-passthrough.md)
- [Event notifications](https://docs.corelightning.org/docs/event-notifications.md)
- [Hooks](https://docs.corelightning.org/docs/hooks.md)
- [Bitcoin backend](https://docs.corelightning.org/docs/bitcoin-backend.md)
- [Plugin manager](https://docs.corelightning.org/docs/plugin-manager.md): Learn how to add your plugin to the `reckless` plugin manager.
- [Tutorials](https://docs.corelightning.org/docs/additional-resources.md)
- [Deprecated Features](https://docs.corelightning.org/docs/deprecated-features.md): Deprecated features and timeline for old feature removals.
- [Tracing CLN Performance](https://docs.corelightning.org/docs/tracing-cln-performance.md)
- [CLN Architecture](https://docs.corelightning.org/docs/contribute-to-core-lightning.md): Familiarise yourself with the core components of Core Lightning.
- [Coding Style Guidelines](https://docs.corelightning.org/docs/coding-style-guidelines.md)
- [Writing JSON Schemas](https://docs.corelightning.org/docs/writing-json-schemas.md)
- [Contributor Workflow](https://docs.corelightning.org/docs/contributor-workflow.md): Learn the practical process and guidelines for contributing.
- [Release Checklist](https://docs.corelightning.org/docs/release-checklist.md)
- [Docker Images](https://docs.corelightning.org/docs/docker-images.md)
- [Testing](https://docs.corelightning.org/docs/testing.md): Understand the testing and code review practices.
- [Code Generation](https://docs.corelightning.org/docs/code-generation.md)
- [Security policy](https://docs.corelightning.org/docs/security-policy.md): Learn how to responsibly report a security issue.

## API Reference
- [/v1/list-methods](https://docs.corelightning.org/reference/get_list_methods_resource.md)
- [/v1/{rpc_method}](https://docs.corelightning.org/reference/post_rpc_method_resource.md): ---  **Demo Node Rune:** YuJqHOZLvCCiL0bY3mT75V_KX_dYNdhTlspcAkGZL5w9MA==
- [addgossip](https://docs.corelightning.org/reference/addgossip.md)
- [addpsbtoutput](https://docs.corelightning.org/reference/addpsbtoutput.md)
- [askrene-age](https://docs.corelightning.org/reference/askrene-age.md)
- [askrene-bias-channel](https://docs.corelightning.org/reference/askrene-bias-channel.md)
- [askrene-bias-node](https://docs.corelightning.org/reference/askrene-bias-node.md)
- [askrene-create-channel](https://docs.corelightning.org/reference/askrene-create-channel.md)
- [askrene-create-layer](https://docs.corelightning.org/reference/askrene-create-layer.md)
- [askrene-disable-node](https://docs.corelightning.org/reference/askrene-disable-node.md)
- [askrene-inform-channel](https://docs.corelightning.org/reference/askrene-inform-channel.md)
- [askrene-listlayers](https://docs.corelightning.org/reference/askrene-listlayers.md)
- [askrene-listreservations](https://docs.corelightning.org/reference/askrene-listreservations.md)
- [askrene-remove-layer](https://docs.corelightning.org/reference/askrene-remove-layer.md)
- [askrene-reserve](https://docs.corelightning.org/reference/askrene-reserve.md)
- [askrene-unreserve](https://docs.corelightning.org/reference/askrene-unreserve.md)
- [askrene-update-channel](https://docs.corelightning.org/reference/askrene-update-channel.md)
- [autoclean-once](https://docs.corelightning.org/reference/autoclean-once.md)
- [autoclean-status](https://docs.corelightning.org/reference/autoclean-status.md)
- [batching](https://docs.corelightning.org/reference/batching.md)
- [bkpr-channelsapy](https://docs.corelightning.org/reference/bkpr-channelsapy.md)
- [bkpr-dumpincomecsv](https://docs.corelightning.org/reference/bkpr-dumpincomecsv.md)
- [bkpr-editdescriptionbyoutpoint](https://docs.corelightning.org/reference/bkpr-editdescriptionbyoutpoint.md)
- [bkpr-editdescriptionbypaymentid](https://docs.corelightning.org/reference/bkpr-editdescriptionbypaymentid.md)
- [bkpr-inspect](https://docs.corelightning.org/reference/bkpr-inspect.md)
- [bkpr-listaccountevents](https://docs.corelightning.org/reference/bkpr-listaccountevents.md)
- [bkpr-listbalances](https://docs.corelightning.org/reference/bkpr-listbalances.md)
- [bkpr-listincome](https://docs.corelightning.org/reference/bkpr-listincome.md)
- [bkpr-report](https://docs.corelightning.org/reference/bkpr-report.md)
- [blacklistrune](https://docs.corelightning.org/reference/blacklistrune.md)
- [cancelrecurringinvoice](https://docs.corelightning.org/reference/cancelrecurringinvoice.md)
- [check](https://docs.corelightning.org/reference/check.md)
- [checkmessage](https://docs.corelightning.org/reference/checkmessage.md)
- [checkrune](https://docs.corelightning.org/reference/checkrune.md)
- [clnrest-register-path](https://docs.corelightning.org/reference/clnrest-register-path.md)
- [close](https://docs.corelightning.org/reference/close.md)
- [commando](https://docs.corelightning.org/reference/commando.md)
- [connect](https://docs.corelightning.org/reference/connect.md)
- [createinvoice](https://docs.corelightning.org/reference/createinvoice.md)
- [createonion](https://docs.corelightning.org/reference/createonion.md)
- [createproof](https://docs.corelightning.org/reference/createproof.md)
- [createrune](https://docs.corelightning.org/reference/createrune.md)
- [currencyconvert](https://docs.corelightning.org/reference/currencyconvert.md)
- [currencyrate](https://docs.corelightning.org/reference/currencyrate.md)
- [datastore](https://docs.corelightning.org/reference/datastore.md)
- [datastoreusage](https://docs.corelightning.org/reference/datastoreusage.md)
- [decode](https://docs.corelightning.org/reference/decode.md)
- [deldatastore](https://docs.corelightning.org/reference/deldatastore.md)
- [delforward](https://docs.corelightning.org/reference/delforward.md)
- [delinvoice](https://docs.corelightning.org/reference/delinvoice.md)
- [delnetworkevent](https://docs.corelightning.org/reference/delnetworkevent.md)
- [delpay](https://docs.corelightning.org/reference/delpay.md)
- [deprecations](https://docs.corelightning.org/reference/deprecations.md)
- [dev-forget-channel](https://docs.corelightning.org/reference/dev-forget-channel.md)
- [dev-splice](https://docs.corelightning.org/reference/dev-splice.md)
- [disableinvoicerequest](https://docs.corelightning.org/reference/disableinvoicerequest.md)
- [disableoffer](https://docs.corelightning.org/reference/disableoffer.md)
- [disconnect](https://docs.corelightning.org/reference/disconnect.md)
- [emergencyrecover](https://docs.corelightning.org/reference/emergencyrecover.md)
- [enableoffer](https://docs.corelightning.org/reference/enableoffer.md)
- [exposesecret](https://docs.corelightning.org/reference/exposesecret.md)
- [feerates](https://docs.corelightning.org/reference/feerates.md)
- [fetchbip353](https://docs.corelightning.org/reference/fetchbip353.md)
- [fetchinvoice](https://docs.corelightning.org/reference/fetchinvoice.md)
- [fundchannel](https://docs.corelightning.org/reference/fundchannel.md)
- [fundchannel_cancel](https://docs.corelightning.org/reference/fundchannel_cancel.md)
- [fundchannel_complete](https://docs.corelightning.org/reference/fundchannel_complete.md)
- [fundchannel_start](https://docs.corelightning.org/reference/fundchannel_start.md)
- [funderupdate](https://docs.corelightning.org/reference/funderupdate.md)
- [fundpsbt](https://docs.corelightning.org/reference/fundpsbt.md)
- [getemergencyrecoverdata](https://docs.corelightning.org/reference/getemergencyrecoverdata.md)
- [getinfo](https://docs.corelightning.org/reference/getinfo.md)
- [getlog](https://docs.corelightning.org/reference/getlog.md)
- [getroute](https://docs.corelightning.org/reference/getroute.md)
- [getroutes](https://docs.corelightning.org/reference/getroutes.md)
- [graceful](https://docs.corelightning.org/reference/graceful.md)
- [help](https://docs.corelightning.org/reference/help.md)
- [injectonionmessage](https://docs.corelightning.org/reference/injectonionmessage.md)
- [injectpaymentonion](https://docs.corelightning.org/reference/injectpaymentonion.md)
- [invoice](https://docs.corelightning.org/reference/invoice.md)
- [invoicerequest](https://docs.corelightning.org/reference/invoicerequest.md)
- [keysend](https://docs.corelightning.org/reference/keysend.md)
- [lightning-cli](https://docs.corelightning.org/reference/lightning-cli.md)
- [lightning-downgrade](https://docs.corelightning.org/reference/lightning-downgrade.md)
- [lightning-hsmtool](https://docs.corelightning.org/reference/lightning-hsmtool.md)
- [lightning-reckless](https://docs.corelightning.org/reference/lightning-reckless.md)
- [lightningd](https://docs.corelightning.org/reference/lightningd.md)
- [lightningd-config](https://docs.corelightning.org/reference/lightningd-config.md)
- [lightningd-rpc](https://docs.corelightning.org/reference/lightningd-rpc.md)
- [listaddresses](https://docs.corelightning.org/reference/listaddresses.md)
- [listchainmoves](https://docs.corelightning.org/reference/listchainmoves.md)
- [listchannelmoves](https://docs.corelightning.org/reference/listchannelmoves.md)
- [listchannels](https://docs.corelightning.org/reference/listchannels.md)
- [listclosedchannels](https://docs.corelightning.org/reference/listclosedchannels.md)
- [listconfigs](https://docs.corelightning.org/reference/listconfigs.md)
- [listcurrencyrates](https://docs.corelightning.org/reference/listcurrencyrates.md)
- [listdatastore](https://docs.corelightning.org/reference/listdatastore.md)
- [listforwards](https://docs.corelightning.org/reference/listforwards.md)
- [listfunds](https://docs.corelightning.org/reference/listfunds.md)
- [listhtlcs](https://docs.corelightning.org/reference/listhtlcs.md)
- [listinvoicerequests](https://docs.corelightning.org/reference/listinvoicerequests.md)
- [listinvoices](https://docs.corelightning.org/reference/listinvoices.md)
- [listnetworkevents](https://docs.corelightning.org/reference/listnetworkevents.md)
- [listnodes](https://docs.corelightning.org/reference/listnodes.md)
- [listoffers](https://docs.corelightning.org/reference/listoffers.md)
- [listpays](https://docs.corelightning.org/reference/listpays.md)
- [listpeerchannels](https://docs.corelightning.org/reference/listpeerchannels.md)
- [listpeers](https://docs.corelightning.org/reference/listpeers.md)
- [listsendpays](https://docs.corelightning.org/reference/listsendpays.md)
- [listsqlschemas](https://docs.corelightning.org/reference/listsqlschemas.md)
- [listtransactions](https://docs.corelightning.org/reference/listtransactions.md)
- [makesecret](https://docs.corelightning.org/reference/makesecret.md)
- [multifundchannel](https://docs.corelightning.org/reference/multifundchannel.md)
- [multiwithdraw](https://docs.corelightning.org/reference/multiwithdraw.md)
- [newaddr](https://docs.corelightning.org/reference/newaddr.md)
- [notifications](https://docs.corelightning.org/reference/notifications.md)
- [offer](https://docs.corelightning.org/reference/offer.md)
- [openchannel_abort](https://docs.corelightning.org/reference/openchannel_abort.md)
- [openchannel_bump](https://docs.corelightning.org/reference/openchannel_bump.md)
- [openchannel_init](https://docs.corelightning.org/reference/openchannel_init.md)
- [openchannel_signed](https://docs.corelightning.org/reference/openchannel_signed.md)
- [openchannel_update](https://docs.corelightning.org/reference/openchannel_update.md)
- [parsefeerate](https://docs.corelightning.org/reference/parsefeerate.md)
- [pay](https://docs.corelightning.org/reference/pay.md)
- [ping](https://docs.corelightning.org/reference/ping.md)
- [plugin](https://docs.corelightning.org/reference/plugin.md)
- [preapproveinvoice](https://docs.corelightning.org/reference/preapproveinvoice.md)
- [preapprovekeysend](https://docs.corelightning.org/reference/preapprovekeysend.md)
- [reckless](https://docs.corelightning.org/reference/reckless.md)
- [recover](https://docs.corelightning.org/reference/recover.md)
- [recoverchannel](https://docs.corelightning.org/reference/recoverchannel.md)
- [renepay](https://docs.corelightning.org/reference/renepay.md)
- [renepaystatus](https://docs.corelightning.org/reference/renepaystatus.md)
- [reserveinputs](https://docs.corelightning.org/reference/reserveinputs.md)
- [sendamount](https://docs.corelightning.org/reference/sendamount.md)
- [sendcustommsg](https://docs.corelightning.org/reference/sendcustommsg.md)
- [sendinvoice](https://docs.corelightning.org/reference/sendinvoice.md)
- [sendonion](https://docs.corelightning.org/reference/sendonion.md)
- [sendpay](https://docs.corelightning.org/reference/sendpay.md)
- [sendpsbt](https://docs.corelightning.org/reference/sendpsbt.md)
- [setchannel](https://docs.corelightning.org/reference/setchannel.md)
- [setconfig](https://docs.corelightning.org/reference/setconfig.md)
- [setpsbtversion](https://docs.corelightning.org/reference/setpsbtversion.md)
- [showrunes](https://docs.corelightning.org/reference/showrunes.md)
- [signinvoice](https://docs.corelightning.org/reference/signinvoice.md)
- [signmessage](https://docs.corelightning.org/reference/signmessage.md)
- [signmessagewithkey](https://docs.corelightning.org/reference/signmessagewithkey.md)
- [signpsbt](https://docs.corelightning.org/reference/signpsbt.md)
- [splice_init](https://docs.corelightning.org/reference/splice_init.md)
- [splice_signed](https://docs.corelightning.org/reference/splice_signed.md)
- [splice_update](https://docs.corelightning.org/reference/splice_update.md)
- [splicein](https://docs.corelightning.org/reference/splicein.md)
- [spliceout](https://docs.corelightning.org/reference/spliceout.md)
- [sql](https://docs.corelightning.org/reference/sql.md)
- [staticbackup](https://docs.corelightning.org/reference/staticbackup.md)
- [stop](https://docs.corelightning.org/reference/stop.md)
- [txdiscard](https://docs.corelightning.org/reference/txdiscard.md)
- [txprepare](https://docs.corelightning.org/reference/txprepare.md)
- [txsend](https://docs.corelightning.org/reference/txsend.md)
- [unreserveinputs](https://docs.corelightning.org/reference/unreserveinputs.md)
- [upgradewallet](https://docs.corelightning.org/reference/upgradewallet.md)
- [utxopsbt](https://docs.corelightning.org/reference/utxopsbt.md)
- [wait](https://docs.corelightning.org/reference/wait.md)
- [waitanyinvoice](https://docs.corelightning.org/reference/waitanyinvoice.md)
- [waitblockheight](https://docs.corelightning.org/reference/waitblockheight.md)
- [waitinvoice](https://docs.corelightning.org/reference/waitinvoice.md)
- [waitsendpay](https://docs.corelightning.org/reference/waitsendpay.md)
- [withdraw](https://docs.corelightning.org/reference/withdraw.md)
- [xkeysend](https://docs.corelightning.org/reference/xkeysend.md)
- [xpay](https://docs.corelightning.org/reference/xpay.md)
- [balance_snapshot](https://docs.corelightning.org/reference/notification-balance_snapshot.md)
- [block_added](https://docs.corelightning.org/reference/notification-block_added.md)
- [channel_open_failed](https://docs.corelightning.org/reference/notification-channel_open_failed.md)
- [channel_opened](https://docs.corelightning.org/reference/notification-channel_opened.md)
- [channel_state_changed](https://docs.corelightning.org/reference/notification-channel_state_changed.md)
- [coin_movement](https://docs.corelightning.org/reference/notification-coin_movement.md)
- [connect](https://docs.corelightning.org/reference/notification-connect.md)
- [custommsg](https://docs.corelightning.org/reference/notification-custommsg.md)
- [deprecated_oneshot](https://docs.corelightning.org/reference/notification-deprecated_oneshot.md)
- [disconnect](https://docs.corelightning.org/reference/notification-disconnect.md)
- [forward_event](https://docs.corelightning.org/reference/notification-forward_event.md)
- [invoice_creation](https://docs.corelightning.org/reference/notification-invoice_creation.md)
- [invoice_payment](https://docs.corelightning.org/reference/notification-invoice_payment.md)
- [log](https://docs.corelightning.org/reference/notification-log.md)
- [onionmessage_forward_fail](https://docs.corelightning.org/reference/notification-onionmessage_forward_fail.md)
- [openchannel_peer_sigs](https://docs.corelightning.org/reference/notification-openchannel_peer_sigs.md)
- [plugin_started](https://docs.corelightning.org/reference/notification-plugin_started.md)
- [plugin_stopped](https://docs.corelightning.org/reference/notification-plugin_stopped.md)
- [sendpay_failure](https://docs.corelightning.org/reference/notification-sendpay_failure.md)
- [sendpay_success](https://docs.corelightning.org/reference/notification-sendpay_success.md)
- [shutdown](https://docs.corelightning.org/reference/notification-shutdown.md)
- [warning](https://docs.corelightning.org/reference/notification-warning.md)
- [xpay_pay_part_end](https://docs.corelightning.org/reference/notification-xpay_pay_part_end.md)
- [xpay_pay_part_start](https://docs.corelightning.org/reference/notification-xpay_pay_part_start.md)
- [commitment_revocation](https://docs.corelightning.org/reference/hook-commitment_revocation.md)
- [custommsg](https://docs.corelightning.org/reference/hook-custommsg.md)
- [db_write](https://docs.corelightning.org/reference/hook-db_write.md)
- [htlc_accepted](https://docs.corelightning.org/reference/hook-htlc_accepted.md)
- [invoice_payment](https://docs.corelightning.org/reference/hook-invoice_payment.md)
- [onion_message_recv](https://docs.corelightning.org/reference/hook-onion_message_recv.md)
- [onion_message_recv_secret](https://docs.corelightning.org/reference/hook-onion_message_recv_secret.md)
- [openchannel](https://docs.corelightning.org/reference/hook-openchannel.md)
- [openchannel2](https://docs.corelightning.org/reference/hook-openchannel2.md)
- [openchannel2_changed](https://docs.corelightning.org/reference/hook-openchannel2_changed.md)
- [openchannel2_sign](https://docs.corelightning.org/reference/hook-openchannel2_sign.md)
- [peer_connected](https://docs.corelightning.org/reference/hook-peer_connected.md)
- [rbf_channel](https://docs.corelightning.org/reference/hook-rbf_channel.md)
- [recover](https://docs.corelightning.org/reference/hook-recover.md)
- [rpc_command](https://docs.corelightning.org/reference/hook-rpc_command.md)

## Recipes
- [Websocket client to connect with clnrest](https://docs.corelightning.org/recipes/websocket-client-to-connect-with-clnrest.md)
- [Write a hello-world plugin in Python](https://docs.corelightning.org/recipes/write-a-hello-world-plugin-in-python.md)
- [Write a program in Python to interact with lightningd](https://docs.corelightning.org/recipes/write-a-program-in-python-to-interact-with-lightningd.md)