Installation

NPM Package

Install the core AXON library for your JavaScript/TypeScript project:

npm install @axon-format/core

Or using yarn:

yarn add @axon-format/core

Or using pnpm:

pnpm add @axon-format/core

CLI Tool

For command-line usage, install the CLI globally:

npm install -g @axon-format/cli

This provides the axon command for:

• Converting JSON files to AXON format
• Decoding AXON back to JSON
• Analyzing token savings
• Validating AXON syntax

Verify Installation

Test that AXON is installed correctly:

import { encode } from '@axon-format/core';

console.log(encode({ test: "Hello AXON!" }));
// Should output AXON-encoded string

Requirements

• Node.js: Version 18 or higher
• TypeScript: 5.0+ (optional, but recommended)