Skip to content

setup.md

Latest commit

 

History

History
92 lines (67 loc) · 1.79 KB

setup.md

File metadata and controls

92 lines (67 loc) · 1.79 KB

Cross-Platform Setup

MAIASS is designed to work seamlessly across Windows, macOS, and Linux with appropriate configuration storage for each platform.

Installation

Prerequisites

  • Node.js 20+
  • npm or yarn
  • Git

Install Dependencies

npm install

Environment Setup

Run the interactive setup:

node setup-env.js

This will:

  • Create OS-appropriate config directories
  • Set up secure storage for sensitive variables
  • Configure general preferences
  • Set appropriate file permissions

Platform-Specific Notes

Windows

  • Uses %APPDATA% and %LOCALAPPDATA% for configuration
  • Automatically handles Windows path separators
  • Secure files stored in user's local app data

macOS

  • Uses ~/Library/Application Support for configuration
  • Follows Apple's guidelines for app data storage
  • Secure permissions (600) applied to sensitive files

Linux

  • Follows XDG Base Directory specification
  • Uses ~/.config and ~/.local/share
  • Respects XDG_CONFIG_HOME and XDG_DATA_HOME if set

Symlink Setup

For easy access, create a symlink:

macOS/Linux

ln -s /path/to/maiass/nodemaiass.sh ~/.local/bin/maiass

Windows (PowerShell as Admin)

New-Item -ItemType SymbolicLink -Path "C:\Windows\System32\maiass.cmd" -Target "C:\path\to\maiass\nodemaiass.sh"

Verification

Test your installation:

maiass hello

You should see:

  • Colored banner with version
  • No module warnings
  • Environment variables loaded from appropriate locations

Troubleshooting

Module Type Warnings

Ensure package.json contains "type": "module"

Permission Errors

Run setup script to fix file permissions:

node setup-env.js

Path Issues

Verify Node.js and npm are in your PATH:

node --version
npm --version