README.md

micoo: quick access to mise-cookbooks

micoo (short for mise cookbooks) is a ⚡ command-line tool that makes it easy to access mise configuration files from mise-cookbooks 📚.

Typical Usage 🚀

# List available cookbooks
micoo list

# Create a new mise.toml with a cookbook
micoo dump python > mise.toml

Features ✨

• 🚀 Quick access to mise-cookbooks
• 📚 Easy cookbook listing and content viewing
• 💾 Simple dumping of cookbooks to mise.toml
• 🔄 Repository cloning and updating
• 🌐 Browser integration for quick repository access
• 🎯 Interactive mode for cookbook selection and generation

Installation 📦

There are several ways to install micoo! 🚀 I recommend using (obviously) mise 🛠️. Here's how to do it:

mise install pipx:micoo

Alternatively, you can install it using uv tool install micoo 🧩

uv tool install micoo

Command Reference 📖

Here is the output of the micoo --help command:

 Usage: micoo [OPTIONS] COMMAND [ARGS]...

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                            │
│ --show-completion             Show completion for the current shell, to copy it or customize the   │
│                               installation.                                                        │
│ --help                        Show this message and exit.                                          │
╰────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────╮
│ update        Clone or fetch the `mise-cookbooks` repository.                                      │
│ list          List the available mise cookbooks.                                                   │
│ search        Search for a mise cookbook.                                                          │
│ dump          Dump a mise cookbook.                                                                │
│ root          Show the path to the micoo boilerplates directory.                                   │
│ log           Show the path to the micoo log file.                                                 │
│ remote        Show the URL to the remote repository.                                               │
│ version       Show the current version number of micoo.                                            │
│ info          Display information about the micoo application.                                     │
│ interactive   Start interactive mode for cookbook selection and generation.                        │
╰────────────────────────────────────────────────────────────────────────────────────────────────────╯

Usage 🛠️

You can use the micoo command to interact with mise-cookbooks. Here are some common commands:

List all available cookbooks:

micoo list

This will output:

Available cookbooks:
- terraform
- python
- cpp
- pnpm
- node
- ruby-on-rails
- opentofu

Dump a specific cookbook to a mise.toml file:

micoo dump python > mise.toml

Open the mise-cookbooks repository in the default application:

open $(micoo remote)

Open the cloned repository in the default application:

open $(micoo root)

Open the log file in the default application:

open $(micoo log)

Show the current version of micoo:

micoo version

Show the information about the micoo application:

micoo info

Start interactive mode for cookbook selection and generation:

micoo interactive

The interactive mode supports multiple output locations:

• mise.toml - Standard configuration file
• mise.local.toml - Local config (not committed to source control)
• mise/config.toml - Configuration in mise subdirectory
• .config/mise.toml - Configuration in .config directory
• .config/mise/config.toml - Configuration in .config/mise subdirectory
• .config/mise/conf.d/custom.toml - Configuration in conf.d directory (alphabetical loading)

Support ❤️

If you have any questions or need help, feel free to open an issue on the GitHub repository.

Author 🫅

This project is maintained by Hasan Sezer Taşan, It's me 👋

Contributing ❤️

Any contributions are welcome! Please follow the Contributing Guidelines to contribute to this project.

Tasks

Clone the repository and cd into the project directory:

git clone https://github.com/hasansezertasan/micoo
cd micoo

The commands below can also be executed using the xc task runner, which combines the usage instructions with the actual commands. Simply run xc, it will pop up an interactive menu with all available tasks.

install

Install the dependencies:

uv sync

style

Run the style checks:

uv run --locked tox run -e style

ci

Run the CI pipeline:

uv run --locked tox run

pypi:readme

Build the README.md file:

uv run hatch-fancy-pypi-readme -o PyPI.md
open PyPI.md

Related Projects ⛓️

• mise - The official mise project
• mise-cookbooks - Collection of mise cookbooks

License 📜

This project is licensed under the MIT License.

Changelog 📝

For a detailed list of changes, please refer to the CHANGELOG.