Skip to Content
CLICommandsProject Configuration

Future Feature: Advanced configuration management commands are planned for future releases. Current projects use standard configuration files that can be edited directly.

Current Configuration

Projects created with create-akinon-app include several configuration files that you can edit directly:

Application Configuration

Located in src/config.ts, this file contains your application’s runtime configuration:

import type { PluginApplicationConfig } from "@akinon/app-client"; export const config: PluginApplicationConfig = { isDev: true, forceRedirect: true, placeholderId: "my-app-placeholder" };

Build Configuration

  • vite.config.ts - Vite build configuration
  • tsconfig.json - TypeScript compiler settings
  • vitest.config.ts - Test configuration

Development Configuration

  • package.json - Dependencies and scripts
  • eslint.config.mjs - Linting rules
  • Prettier config - Code formatting preferences

Planned Configuration Commands

Future releases will include CLI commands for easier configuration management:

Configuration Management

# Planned commands (not yet available) akinon-ui config:get <key> # Get configuration value akinon-ui config:set <key> <value> # Set configuration value akinon-ui config:list # List all configuration akinon-ui config:reset # Reset to defaults

Environment Configuration

# Planned commands (not yet available) akinon-ui config:env # Manage environment variables akinon-ui config:theme # Configure shell themes akinon-ui config:build # Build configuration options

Planned Features

The future configuration system will provide:

  • Unified Configuration - Single interface for all project settings
  • Environment Management - Easy switching between development/staging/production
  • Theme Configuration - Shell appearance and behavior settings
  • Build Optimization - Performance and bundle configuration
  • Validation - Automatic configuration validation and suggestions

Current Best Practices

While waiting for CLI configuration commands:

1. Use TypeScript for Configuration

Keep configuration files in TypeScript for better type safety and IDE support.

2. Environment Variables

Use .env files for environment-specific settings:

# .env.local VITE_API_URL=http://localhost:8000 VITE_DEBUG=true

3. Consistent Structure

Follow the established configuration patterns from your project template.

4. Version Control

Keep configuration files in version control, but exclude sensitive environment files.

Migration Plan

When configuration commands become available:

  • Existing manual configurations will be automatically detected
  • Migration tools will help convert to the new system
  • No breaking changes to existing projects

Current manual configuration will remain supported alongside the new CLI commands, providing flexibility for different workflows.