Skip to content

quick_start.md

Latest commit

 

History

History
77 lines (47 loc) · 1.56 KB

quick_start.md

File metadata and controls

77 lines (47 loc) · 1.56 KB

Quick start

This guide will help you quickly start using Amphimixis.

Installation

1. Clone the repository

git clone https://github.com/ebzych/amphimixis.git
cd amphimixis

2. Build and install

uv build
pip install dist/*.whl --break-system-packages

Prepare the working directory

Amphimixis requires a clean working directory to store configuration files and build artifacts.

Before running the tool, ensure your directory contains a valid input.yml configuration file.

Run Amphimixis

Run amixis from your working directory by passing the project path as an argument.

Basic usage

amixis /path/to/project

This command will perform the full workflow for the specified project directory:

  • Analyze the project to detect CI systems, tests and etc.

  • Build the project according to the generated configuration files.

  • Profile the performance of the builds and collect execution statistics.

All of the steps listed above can also be performed individually. Below are examples for each operation.

Analyze project

amixis --analyze /path/to/project

Build project

amixis --build /path/to/project

Profile project

amixis --profile /path/to/project

Use a custom configuration file

To use a configuration file other than the default input.yml, use the --config flag:

amixis --config=./my_input.yml /path/to/project