Contribute

Contribute to Miblo’s open-source CLI, templates and documentation on GitHub.

On this page

Repositories

  • Miblo: CLI, terminal UI, generation and project management.
  • miblo_templates: Handlebars packs and published archives.
  • miblo_site: this website and documentation.

Report bugs, suggest improvements or contribute source changes on GitHub. Miblo uses the MIT license.

Check the CLI

shell
cargo fmt --check
cargo clippy --locked --all-targets -- -D warnings
cargo test --locked

Repository scripts also cover installation, generation, migrations, SQLite/MySQL CRUD and the terminal UI. Test dependencies are listed in scripts/requirements-test.txt.

Test a generated API

With CLI and template repositories in adjacent directories:

shell
cargo build --locked
python3 scripts/smoke_sqlite.py \
  --miblo target/debug/miblo \
  --templates ../miblo_templates/rust_sqlite_template_v4 \
  --target-dir target/sqlite-smoke

These tests use temporary projects and data. See the development branch README for MySQL, terminal and installation checks and their dependencies.

Before a release

Check installation, generation from published templates, migrations and preservation of handwritten changes. The automated terminal test runs on Unix; also check the Windows terminal.

The CLI, templates and website are published separately. Each repository describes its checks.

Search for a feature or command.

↑ ↓ browse Enter to open