Skip to content

Getting Started

LoSkroefie edited this page Jan 21, 2025 · 1 revision

Getting Started with FlexonCLI 🚀

Installation

Prerequisites

  • .NET 8.0 or higher
  • Git (optional, for development)

Installation Methods

  1. Using .NET Tool
dotnet tool install -g flexon-cli
  1. Using Homebrew (macOS)
brew install flexon-cli
  1. Using Chocolatey (Windows)
choco install flexon-cli
  1. Manual Installation
  • Download the latest release from GitHub
  • Extract to your preferred location
  • Add to system PATH

Basic Usage

1. Serialize JSON Data

flexon-cli serialize -i input.json -o output.flexon

2. Deserialize Flexon Data

flexon-cli deserialize -i input.flexon -o output.json

3. Package Multiple Files

flexon-cli serialize -i config.json -i image.png -o package.flexon

4. Use Encryption

flexon-cli serialize -i data.json -o secure.flexon -e myKey

5. Validate Against Schema

flexon-cli serialize -i data.json -o valid.flexon -s schema.json

Quick Examples

Basic Data Storage

# Store configuration
flexon-cli serialize -i config.json -o app_config.flexon

# Store with encryption
flexon-cli serialize -i config.json -o secure_config.flexon -e myKey

# Store multiple files
flexon-cli serialize -i config.json -i assets.png -o package.flexon

AI Data Management

# Store AI prompts
flexon-cli serialize -i prompts.json -o ai_prompts.flexon -s prompt_schema.json

# Package training data
flexon-cli serialize -i training.json -i embeddings.bin -o ai_package.flexon

Game State Management

# Save game state
flexon-cli serialize -i state.json -i screenshots.png -o save.flexon -e gameKey

# Load game state
flexon-cli deserialize -i save.flexon -o ./game_data -e gameKey

Next Steps

Clone this wiki locally