The Ayase Quart CLI provides comprehensive tools for managing your 4chan/Lainchan archive system. It includes commands for system preparation, search index management, and moderation workflows.
Command structure
Ayase Quart provides two CLI interfaces:
ayaseq command (main CLI)
The primary CLI accessible via the ayaseq command:
ayaseq < comman d > < subcomman d > [options]
Available command groups:
prep - System preparation and configuration
search - Search index management and loading
reports command (legacy CLI)
A separate Click-based CLI for moderation:
python -m ayase_quart.cli.reports < comman d > [options]
prep System preparation and configuration
search Search index management and loading
reports User report and moderation management
Quick start
Prepare the system
Generate required secrets and hashes before first launch: ayaseq prep secret
ayaseq prep hashjs
ayaseq prep boards
Set up search indexing
Initialize the search index and load posts: ayaseq search index create
ayaseq search load full a vg
Monitor reports
View and manage user-submitted reports: python -m ayase_quart.cli.reports cli-get-reports
Getting help
Display help for any command by running it without arguments or with --help:
ayaseq --help
ayaseq prep --help
ayaseq search index --help
python -m ayase_quart.cli.reports --help
Common patterns
Running with cron
Use the --cron flag to run incremental operations continuously:
ayaseq search load incr --cron 300 a vg
This will index new posts every 300 seconds (5 minutes).
Filtering by board
Many commands accept board shortnames to limit operations:
ayaseq search load full a vg pol
python -m ayase_quart.cli.reports cli-get-reports -boards a -boards vg
Working with reports
Report IDs are used throughout the moderation commands:
# View reports
python -m ayase_quart.cli.reports cli-get-reports
# Count reports
python -m ayase_quart.cli.reports cli-get-report-count
# Take action on specific reports
python -m ayase_quart.cli.reports cli-reports-action -id 123 -action post_hide
The CLI uses Python’s asyncio for database and search operations. Some commands may take time to complete depending on the size of your archive.
CLI entry points
From pyproject.toml:
[ project . scripts ]
ayaseq = 'ayase_quart.cli:main'
This creates the ayaseq command when the package is installed.
For the reports CLI, run the module directly:
python -m ayase_quart.cli.reports