# Support

Thanks for using FuXi! Here is where to go depending on what you need.

## Documentation

- [README](https://github.com/fuxicodex/Fuxi/blob/main/README.md) — overview, installation, usage guide, configuration
- [Keyboard shortcuts](https://github.com/fuxicodex/Fuxi/blob/main/docs/keybindings.md) — the terminal UI key reference
- [FAQ](https://github.com/fuxicodex/Fuxi/blob/main/docs/faq.md) — answers to common questions
- `fuxi --help` — full flag and subcommand reference
- `fuxi doctor` — environment sanity checks (config, API key, git, ripgrep, ...)

## Reporting problems

- **Bugs** — open an issue using the **Bug report** template. Include `fuxi
  --version`, your OS/shell/terminal, and a minimal reproduction.
- **Feature requests** — open an issue using the **Feature request** template.
- **Security vulnerabilities** — do **not** open a public issue. Report
  privately via [GitHub security advisories](https://github.com/fuxicodex/Fuxi/security/advisories/new);
  see [SECURITY.md](https://github.com/fuxicodex/Fuxi/blob/main/SECURITY.md).

## Contributing

Documentation improvements are welcome — see
[CONTRIBUTING.md](https://github.com/fuxicodex/Fuxi/blob/main/CONTRIBUTING.md)
for conventions. Please read our
[Code of Conduct](https://github.com/fuxicodex/Fuxi/blob/main/CODE_OF_CONDUCT.md)
before participating.

## Community guidelines

- Be respectful and constructive in all interactions.
- Do not include API keys, credentials, or personal data in issues, PRs, or
  attachments — redact secrets before pasting config snippets or logs.

Support is provided on a best-effort basis by the maintainers.