2.5 KiB
| linkTitle | title | prev | next | weight |
|---|---|---|---|---|
| 🧑🍳 Development | Developing with RF Swift | /docs/guide | /docs/development/compiling-rfswift | 4 |
RF Swift Development Guide
This section covers topics related to developing with RF Swift, building custom components, and contributing to the project. Whether you want to compile the RF Swift binary from source, create custom container images, or extend the project's capabilities, you'll find the necessary guidance here.
Getting Started with Development
RF Swift is designed to be extensible and customizable. You can tailor it to your specific RF assessment needs by:
- Compiling the binary from source with custom features or for specific architectures
- Building custom container images with specialized tools
- Contributing to the core project by adding new features or fixing issues
Key Development Areas
{{< cards >}} {{< card link="compiling-rfswift" title="Compile RF Swift Binary" icon="chip" subtitle="Build the RF Swift binary from source for different platforms and architectures" >}} {{< card link="building-images" title="Building Custom Images" icon="beaker" subtitle="Create specialized Docker images with your preferred RF and security tools" >}} {{< /cards >}}
Development Environment Setup
Before diving into RF Swift development, ensure your environment meets these prerequisites:
Prerequisites
- Go 1.20+: Required for compiling the RF Swift binary
- Docker: Required for building and testing container images
- BuildX: Required for cross-platform image building
- Git: Required for source code management
Cross-Platform Development
RF Swift supports multiple platforms and architectures. When developing:
- Test on multiple operating systems when possible
- Use BuildX for cross-platform container builds
- Consider architecture-specific optimizations for ARM64 and RISC-V
Community Resources
Join the RF Swift community to get help with development:
- Discord: Join our Discord server
- GitHub Issues: Report bugs or request features
- Documentation: Refer to the API Reference (coming soon)
{{< callout emoji="🚧" >}} Additional development documentation is being actively created. We welcome contributions to the documentation, especially for specialized development scenarios and custom image creation. {{< /callout >}}