https://github.com/tandemdude/hikari-lightbulb
Simple, elegant and powerful command handler for the Python Discord library, Hikari.
https://github.com/tandemdude/hikari-lightbulb
api-wrapper bot command-handler discord discord-api discord-bot hikari python python-3
Last synced: about 1 month ago
JSON representation
Simple, elegant and powerful command handler for the Python Discord library, Hikari.
- Host: GitHub
- URL: https://github.com/tandemdude/hikari-lightbulb
- Owner: tandemdude
- License: mit
- Created: 2020-11-26T15:56:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2026-04-02T23:55:10.000Z (2 months ago)
- Last Synced: 2026-04-05T20:02:23.905Z (2 months ago)
- Topics: api-wrapper, bot, command-handler, discord, discord-api, discord-bot, hikari, python, python-3
- Language: Python
- Homepage: https://hikari-lightbulb.readthedocs.io/en/latest/
- Size: 8.39 MB
- Stars: 219
- Watchers: 2
- Forks: 36
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-discord - hikari-lightbulb - The official unofficial command handler for the Python discord API wrapper library, Hikari. (Misc Resources)
README
[](https://pypi.org/project/hikari-lightbulb)
# Overview
Lightbulb is designed to be an easy-to-use command handler library that integrates with the
Discord API wrapper library for Python, Hikari.
This library aims to make it simple for you to make your own Discord bots and provide
all the utilities and functions you need to help make this job easier.
## Installation
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install Lightbulb.
```bash
pip install hikari-lightbulb
```
## Usage
```python
# Import the libraries
import hikari
import lightbulb
# Create a GatewayBot instance
bot = hikari.GatewayBot("your_token_here")
client = lightbulb.client_from_app(bot)
# Ensure the client starts once the bot is run
bot.subscribe(hikari.StartingEvent, client.start)
# Register the command with the client
@client.register()
class Ping(
# Command type - builtins include SlashCommand, UserCommand, and MessageCommand
lightbulb.SlashCommand,
# Command declaration parameters
name="ping",
description="checks the bot is alive",
):
# Define the command's invocation method. This method must take the context as the first
# argument (excluding self) which contains information about the command invocation.
@lightbulb.invoke
async def invoke(self, ctx: lightbulb.Context) -> None:
# Send a message to the channel the command was used in
await ctx.respond("Pong!")
# Run the bot
# Note that this is blocking meaning no code after this line will run
# until the bot is shut off
bot.run()
```
## Sponsors
I would like to give a special thanks to my sponsors for providing the funding to continue developing and improving
this resource over the past 5+ years.
- [nulldomain](https://github.com/null-domain)
- [Invite Tracker](https://invite-tracker.com)
- [Forbidden-A](https://github.com/Forbidden-A)
## Large Bots
The following large bots are all using Lightbulb in production:
Do you own a large bot using Lightbulb? Mention `@thomm.o` on [Discord](https://discord.gg/hikari) or submit a pull request to add your bot to the list!
## Show your Support
We love people's support in growing and improving. Be sure to leave a ⭐️ if you like the project, and I would gladly welcome
any contributions if you're interested!
## Links
- **License:** [MIT](https://choosealicense.com/licenses/mit/)
- **Repository:** [GitHub](https://github.com/tandemdude/hikari-lightbulb)
- **Documentation:** [ReadTheDocs](https://hikari-lightbulb.readthedocs.io/en/latest/)
## IDE Plugin
Lightbulb now has a plugin for IntelliJ-based IDEs (IntelliJ, Pycharm, etc) to help improve the developer experience
by providing autocompletion and type checking not yet supported by other tools. More features such as command
boilerplate generation and further code inspections are planned.
You can install the plugin from the Jetbrains Marketplace within your IDE. View the plugin
[here](https://plugins.jetbrains.com/plugin/24669-hikari-lightbulb-support).
