Getting Started#
Welcome to APX! This section will help you get up and running quickly with the API Publishing eXperience CLI.
What You’ll Learn#
Installation: How to install APX on your system
Quick Start: Your first APX project in 5 minutes
Interactive Initialization: Using APX’s guided setup
Prerequisites#
Before you begin, make sure you have:
Go 1.26+ (for installation from source)
Git (for version control operations)
GitHub or Gitea as your canonical repository hosting platform
Basic familiarity with command-line tools
Note
Platform requirement: APX 1.0 will support GitHub (github.com or GitHub Enterprise) and Gitea (self-hosted) as Git hosting platforms for the canonical repository. GitLab, Bitbucket, Azure DevOps, and other platforms are non-goals for v1.0. See Platform Requirements.
Choose Your Path#
🚀 New to APX?
Start with installation and basic setup
⚡ Ready to Go?
Jump straight into creating your first schema
What’s Next?#
Once you’ve completed the getting started guide, you can:
Explore the User Guide for detailed workflows
Check out Examples for real-world use cases
Reference the CLI Documentation for all commands