Getting Started

Installation

How to install m1f and its dependencies

Get started with m1f in seconds! Use our automated installation script for the quickest setup.

Prerequisites

  • Python 3.10 or newer - m1f requires modern Python with async support
  • Git - For cloning the repository
  • curl or wget - For downloading the installer (usually pre-installed)

Quick Install

The fastest way to get started:

# Download and run the installer
curl -sSL https://raw.githubusercontent.com/franz-agency/m1f/main/scripts/install.sh | bash

# Or with wget
wget -qO- https://raw.githubusercontent.com/franz-agency/m1f/main/scripts/install.sh | bash

That’s it! The installer will:

  • Clone the m1f repository
  • Set up Python virtual environment
  • Install all dependencies
  • Configure shell aliases
  • Initialize m1f in your current directory

Installation Options

# Using curl
curl -sSL https://raw.githubusercontent.com/franz-agency/m1f/main/scripts/install.sh | bash

# Or save and review the script first
curl -sSL https://raw.githubusercontent.com/franz-agency/m1f/main/scripts/install.sh -o install-m1f.sh
cat install-m1f.sh  # Review the script
bash install-m1f.sh

Option 2: Manual Installation

If you prefer to install manually:

# Clone the repository
git clone https://github.com/franz-agency/m1f.git
cd m1f

# Run the local installer
bash scripts/install.sh

Option 3: Windows Installation

For Windows users:

# Download and run PowerShell installer
Invoke-WebRequest -Uri https://raw.githubusercontent.com/franz-agency/m1f/main/scripts/install.ps1 -OutFile install-m1f.ps1
.\install-m1f.ps1

Verify Installation

After installation, verify everything is working:

# Check version
m1f --version

# View help
m1f --help

# List all available tools
m1f-init --help
m1f-s1f --help
m1f-html2md --help
m1f-scrape --help
m1f-token-counter --help

Optional Dependencies

For Enhanced Security Scanning

pip install detect-secrets

This enables advanced secret detection in your files.

For Web Scraping

# For HTTrack backend
sudo apt-get install httrack  # On Ubuntu/Debian
brew install httrack          # On macOS

# For Playwright backend
pip install playwright
playwright install

For Additional HTML Processing

pip install selectolax  # Fast HTML parser
pip install scrapy      # Advanced web scraping

Project Initialization

Once installed, initialize m1f in your project:

cd /your/project
m1f-init

This creates:

  • m1f/ directory with bundled files
  • .m1f.config.yml configuration file
  • Sample bundle files for your project

Troubleshooting

Python Version Issues

If you see import errors, ensure you’re using Python 3.10+:

python --version
# Should show Python 3.10.x or higher

Permission Errors

If you encounter permission issues:

# Make sure you own the directory
sudo chown -R $USER:$USER /path/to/m1f

# Or install in user directory
pip install --user -r requirements.txt

Virtual Environment Issues

If virtual environment activation fails:

# Recreate the environment
rm -rf .venv
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Next Steps

After installation:

  1. Follow the Quick Start guide - Create your first bundle in under a minute
  2. Learn Core Concepts - Understand how m1f works
  3. Initialize your project - Set up m1f in your repository

Updating

To update m1f to the latest version:

# Navigate to m1f directory
cd ~/m1f  # or wherever you installed it

# Pull latest changes
git pull origin main

# Update dependencies
pip install -r requirements.txt

Uninstallation

To completely remove m1f:

# Run the uninstaller
bash ~/m1f/scripts/uninstall.sh

# Or manually remove
rm -rf ~/m1f
# Remove aliases from your shell config (.bashrc, .zshrc, etc.)
Next
Auto Bundle