Skip to content

Getting Started

Welcome to APX! This section will help you get up and running with the API Publishing eXperience CLI.

What You'll Learn

  • Installation: How to install APX on your system
  • Quick Start: Set up your repos in 5 minutes
  • Tutorial: Complete walkthrough — authoring, local dev, releasing, and consuming APIs
  • Initialization Guide: Smart defaults, prompts, flags, and team onboarding for apx init

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.

    Install APX

  • 5-Minute Setup

    Create your canonical and app repos, validate the setup.

    Quick Start

  • Full Walkthrough

    Author schemas, develop locally, release, and consume APIs end to end.

    Tutorial

What's Next?

Once you've completed the getting started guide, you can: