# Reliafy CLI

Reliafy CLI provides reliability analysis, design, and simulation workflows with simple profile-based configuration.

## Quick Start

```zsh
# Install from PyPI
pip install reliafy

# Show help
python -m reliafy --help

# Copy packaged example problems
python -m reliafy examples cp

# Run an analysis with the default profile
python -m reliafy analyze default --include-sorm --plot-rfad
```

## Profiles

Profiles are YAML files under `profiles/` that control run options.

```zsh
# Create and edit a custom profile
python -m reliafy profile new custom
python -m reliafy profile nano custom
# or
python -m reliafy profile vim custom

# Validate, list, copy, rename
python -m reliafy profile val custom
python -m reliafy profile ls
python -m reliafy profile cp default mycopy
python -m reliafy profile mv oldname newname
```

## Full Documentation

The complete documentation site is built with MkDocs Material.

- Site navigation mirrors CLI commands and common tasks.
- Developer preview: `mkdocs serve` then open the shown URL.

## Requirements

- Python 3.10+
- Internet connection for API access and authentication

## Notes

- Auth0 device flow uses public values (domain, client ID, audience). No client secret is used in the CLI.
- Packaged example problems are available under `reliafy/examples/problems`.
