Files
l-ui/docs/CONTRIBUTING.md
T
Muse 6a5ee8f77b rename: 3x-ui/x-ui -> L-UI/l-ui/lui-agent (paths, services, env, assets)
Display L-UI; panel binary/process l-ui, agent lui-agent.
Dirs /usr/local/l-ui, /etc/l-ui, /var/log/l-ui; DB /etc/l-ui/l-ui.db
(name file drives it via GetName), probe.db beside it, cert
/etc/l-ui/cert, bin /usr/local/l-ui/bin. Services l-ui.service /
lui-agent.service, OpenRC lui-agent, l-ui.sh, cmd/lui-agent.
Env prefix XUI_ -> LUI_ (code reads new prefix only). Release
assets l-ui-linux-* / lui-agent-linux-*; Gitea repo rogue/l-ui is
a placeholder pending user confirmation (see selfupdate.go note).
Go module path github.com/mhsanaei/3x-ui/v3 intentionally kept.
Versions unchanged: panel V2.6.0 / agent A2.5.0.
2026-10-24 12:00:55 +00:00

1.4 KiB

Contributing to L-UI-docs

Thanks for helping improve the L-UI documentation and product site!

Prerequisites

This project uses pnpm (not npm — package-lock.json is gitignored). Install dependencies and start the dev server:

pnpm install
pnpm dev        # http://localhost:3000

Scripts

Script Description
pnpm dev Start the dev server
pnpm build Production build
pnpm start Serve the production build
pnpm typecheck Generate MDX/route types and run tsc --noEmit
pnpm lint oxlint (.oxlintrc.json)
pnpm format Format with oxfmt (.oxfmtrc.json)
pnpm test Run unit tests (Vitest) for lib/xray/* pure logic
pnpm gen:api Generate the API reference from public/openapi.json

Before opening a pull request, please run pnpm typecheck, pnpm lint, pnpm format:check, and pnpm test — these are the same checks that CI runs on every PR.

License

By contributing, you agree that your contributions will be licensed under the project's GPL-3.0 license.