Convert & Extract
Outlook OST Files

Configuration

OST2GO works out of the box with sensible defaults, but you can customize its behavior.

Global Installation

npm install -g ost2go

Local Installation

# Install locally
npm install ost2go

# Run with npx
npx ost2go --help

Environment Requirements

• Node.js: Version 18.0.0 or higher
• Memory: Recommended 2GB+ RAM for large files
• Disk Space: Ensure sufficient space for output files
• OS: Windows, macOS, or Linux

Common Options

Command Reference

Complete reference for all OST2GO commands.

ost2go convert -i input.ost -o output.pst [options]

Options:
  -i, --input        Input OST file path (required)
  -o, --output       Output PST file path (required)
  --real             Use real conversion mode (recommended)
  --legacy           Use legacy conversion mode
  --max-emails       Maximum number of emails to convert

ost2go extract -i input.ost -o output/ [options]

Options:
  -i, --input        Input OST file path (required)
  -o, --output       Output directory or file path (required)
  --format           Output format: eml, mbox, json (default: eml)
  --max              Maximum number of emails to extract

ost2go info -i file.ost

Options:
  -i, --input        Input OST or PST file path (required)

ost2go validate -i file.pst

Options:
  -i, --input        Input PST file path (required)

Modify & Extend

Learn how to customize and extend OST2GO for your needs.

Project Structure

ost2go/
├── src/
│   ├── analyzer/     # OST/PST file analysis
│   ├── converter/    # Conversion logic
│   ├── extractor/    # Email extraction
│   ├── parser/       # File parsing
│   ├── scanner/      # Database scanning
│   ├── validator/    # PST validation
│   └── writer/       # PST file writing
├── bin/              # CLI entry point
├── docs/             # Documentation
└── test/             # Tests

Clone & Setup

# Clone repository
git clone https://github.com/SkyLostTR/OST2GO.git
cd OST2GO

# Install dependencies
npm install

# Run tests
npm test

Adding New Features

To add new features, follow the modular architecture:

1. Create a new module in the appropriate src/ subdirectory
2. Follow the existing code style and patterns
3. Add JSDoc comments for all public methods
4. Include copyright header in all source files
5. Update tests in test/ directory
6. Document changes in CHANGELOG.md

Code Style

/**
 * OST2GO - [Module Name]
 * 
 * [Brief description]
 * 
 * @author SkyLostTR (@Keeftraum)
 * @license SEE LICENSE IN LICENSE
 * @repository https://github.com/SkyLostTR/OST2GO
 */

class YourModule {
    /**
     * @param {Object} options Configuration options
     */
    constructor(options = {}) {
        // Clear, descriptive variable names
        this.maxRetries = options.maxRetries || 3;
    }
}

Running Tests

# Run all tests
npm test

# Test specific commands
ost2go extract -i yourfile.ost -o test --max 10
ost2go info -i yourfile.ost

Contributing

Contributions are welcome! Please:

• Fork the repository
• Create a feature branch
• Make your changes with clear commit messages
• Test thoroughly
• Submit a pull request

License

OST2GO is licensed under a proprietary license.

Copyright

© 2024-2025 SkyLostTR (@Keeftraum). All rights reserved.

Terms

Third-Party Dependencies

OST2GO uses the following open-source packages:

• chalk - Terminal string styling
• cli-progress - Progress bars for CLI
• commander - Command-line interface framework

See package.json for complete dependency list and versions.

Known Limitations

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Author: @SkyLostTR on GitHub