fontist 2.1.3 → 2.1.4

data/docs/cli/import.md

@@ -0,0 +1,136 @@
+# fontist import
+
+Import fonts from external sources and create Fontist formulas.
+
+## Subcommands
+
+| Command | Description |
+|---------|-------------|
+| [`fontist import google`](#import-google) | Import Google Fonts |
+| [`fontist import macos`](#import-macos) | Import macOS supplementary fonts |
+| [`fontist import sil`](#import-sil) | Import SIL International fonts |
+
+---
+
+## import google
+
+Import fonts from the Google Fonts repository.
+
+### Syntax
+
+```sh
+fontist import google [options]
+```
+
+### Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `--source-path` | string | Path to checked-out google/fonts repository |
+| `--output-path` | string | Output path for generated formulas (default: ./Formulas/google) |
+| `--font-name` | string | Import specific font family by name |
+| `--force` | boolean | Overwrite existing formulas |
+| `--verbose` | boolean | Enable verbose output |
+| `--import-cache` | string | Directory for import cache |
+
+### Examples
+
+```sh
+# Import all Google fonts
+fontist import google
+
+# Import a specific font
+fontist import google --font-name "Roboto"
+
+# Import with custom source
+fontist import google --source-path /path/to/google/fonts
+```
+
+---
+
+## import macos
+
+Import macOS supplementary fonts from system catalogs.
+
+### Syntax
+
+```sh
+fontist import macos [options]
+```
+
+### Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `--plist` | string | Path to macOS font catalog XML |
+| `--output-path` | string | Output directory for generated formulas |
+| `--font-name` | string | Import specific font by name |
+| `--force` | boolean | Overwrite existing formulas |
+| `--verbose` | boolean | Enable verbose output |
+| `--import-cache` | string | Directory for import cache |
+
+### Examples
+
+```sh
+# Import from detected macOS catalogs
+fontist import macos
+
+# Import from specific catalog
+fontist import macos --plist /path/to/com_apple_MobileAsset_Font8.xml
+
+# Import specific font
+fontist import macos --font-name "SF Pro"
+```
+
+### Finding macOS Catalogs
+
+Run `fontist macos-catalogs` to list available font catalogs on your system.
+
+---
+
+## import sil
+
+Import fonts from SIL International.
+
+### Syntax
+
+```sh
+fontist import sil [options]
+```
+
+### Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `--output-path` | string | Output directory for generated formulas |
+| `--font-name` | string | Import specific font by name |
+| `--force` | boolean | Overwrite existing formulas |
+| `--verbose` | boolean | Enable verbose output |
+| `--import-cache` | string | Directory for import cache |
+
+### Examples
+
+```sh
+# Import all SIL fonts
+fontist import sil
+
+# Import specific font
+fontist import sil --font-name "Gentium Plus"
+```
+
+---
+
+## Use Cases
+
+The import commands are useful for:
+
+- **Formula maintainers**: Creating formulas for new fonts
+- **Private fonts**: Creating formulas for internal fonts
+- **Bulk imports**: Converting large font collections to Fontist formulas
+
+## Requirements
+
+These commands require additional setup:
+- `google`: Access to the google/fonts repository
+- `macos`: macOS system or font catalog files
+- `sil`: Network access to SIL font servers

data/docs/cli/index-cmd.md

@@ -0,0 +1,37 @@
+# fontist index
+
+Rebuild the system font index by scanning system font directories.
+
+## Syntax
+
+```sh
+fontist index
+```
+
+## Aliases
+
+- `fontist index-rebuild` - Same as index
+
+## Description
+
+Rebuilds the system font index by scanning system font directories. This command scans your system for available fonts and rebuilds Fontist's internal index of system fonts.
+
+This is useful when:
+- New fonts have been installed on your system outside of Fontist
+- The font index has become corrupted or out of date
+- You want Fontist to recognize newly installed system fonts
+
+## Examples
+
+```sh
+# Rebuild the system font index
+fontist index
+
+# Using the alias
+fontist index-rebuild
+```
+
+## Related Commands
+
+- [fontist status](/cli/status) - Show installed font paths
+- [fontist list](/cli/list) - List available and installed fonts

data/docs/cli/index.md

@@ -0,0 +1,80 @@
+# Fontist CLI Reference
+
+Complete command-line interface reference for Fontist.
+
+## Quick Reference
+
+| Command | Description |
+|---------|-------------|
+| [`fontist install`](/cli/install) | Install fonts |
+| [`fontist uninstall`](/cli/uninstall) | Uninstall fonts |
+| [`fontist list`](/cli/list) | List font status |
+| [`fontist status`](/cli/status) | Show font paths |
+| [`fontist update`](/cli/update) | Update formulas |
+| [`fontist version`](/cli/version) | Show version info |
+
+## Subcommands
+
+| Command | Description |
+|---------|-------------|
+| [`fontist manifest`](/cli/manifest) | Manifest management |
+| [`fontist index`](/cli/index-cmd) | System font index |
+| [`fontist cache`](/cli/cache) | Cache management |
+| [`fontist config`](/cli/config) | Configuration |
+| [`fontist repo`](/cli/repo) | Custom repositories |
+| [`fontist fontconfig`](/cli/fontconfig) | Fontconfig integration |
+| [`fontist import`](/cli/import) | Import fonts |
+| [`fontist create-formula`](/cli/create-formula) | Create formulas |
+
+## Global Options
+
+These options work with all commands:
+
+| Option | Description |
+|--------|-------------|
+| `--quiet` | Suppress output |
+| `--verbose` | Enable verbose output |
+| `--debug` | Enable debug output |
+| `--color` | Force colored output |
+| `--no-color` | Disable colored output |
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `FONTIST_PATH` | Override Fontist directory (default: `~/.fontist`) |
+| `FONTIST_NO_PROGRESS` | Disable progress bars |
+
+## Getting Help
+
+```sh
+# Show general help
+fontist help
+
+# Show command-specific help
+fontist install --help
+fontist manifest --help
+```
+
+## Exit Codes
+
+Fontist uses standard exit codes for scripting. See the [Exit Codes Reference](/cli/exit-codes) for details.
+
+---
+
+## Installation
+
+```sh
+gem install fontist
+```
+
+## Prerequisites
+
+- Ruby 2.7 or higher
+- Network access for downloading fonts
+
+## Next Steps
+
+- [Getting Started Guide](/guide/) - Learn the basics
+- [Using Fontist in CI](/guide/ci) - CI/CD integration
+- [Manifest Support](/cli/manifest) - Reproducible installations

data/docs/cli/install.md

@@ -0,0 +1,52 @@
+# fontist install
+
+Install one or more fonts from the Fontist formula repository.
+
+## Syntax
+
+```sh
+fontist install FONT... [options]
+```
+
+## Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `FONT` | Yes | One or more font names to install (variadic) |
+
+## Options
+
+<CliOptions command="install" />
+
+## Examples
+
+<CliExamples command="install" />
+
+## Multi-font Installation
+
+You can install multiple fonts at once:
+
+```sh
+fontist install "Fira Code" "Open Sans" "Roboto"
+```
+
+When installing multiple fonts, Fontist will:
+- Install all fonts in parallel
+- Report successes and failures separately
+- Return appropriate exit code based on results
+
+## Install Locations
+
+The `--location` option controls where fonts are installed:
+
+| Location | Description | Default |
+|----------|-------------|---------|
+| `fontist` | Fontist's own fonts directory | Yes |
+| `user` | User's local fonts directory | No |
+| `system` | System-wide fonts directory (may require admin rights) | No |
+
+## Related Commands
+
+- [fontist uninstall](/cli/uninstall) - Remove installed fonts
+- [fontist list](/cli/list) - List available and installed fonts
+- [fontist status](/cli/status) - Show installed font paths

data/docs/cli/list.md

@@ -0,0 +1,39 @@
+# fontist list
+
+List installation status of fonts available in Fontist.
+
+## Syntax
+
+```sh
+fontist list [FONT]
+```
+
+## Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `FONT` | No | Optional font name to filter results |
+
+## Examples
+
+```sh
+# List all fonts and their installation status
+fontist list
+
+# Check status of a specific font
+fontist list "Fira Mono"
+```
+
+## Output Format
+
+The list shows:
+- Formula name
+- Font name
+- Style type (Regular, Bold, Italic, etc.)
+- Installation status (installed/not installed)
+- Manual flag (if font requires manual installation)
+
+## Related Commands
+
+- [fontist install](/cli/install) - Install fonts
+- [fontist status](/cli/status) - Show installed font paths

data/docs/cli/manifest.md

@@ -0,0 +1,110 @@
+# fontist manifest
+
+Manage font manifests for reproducible font installations.
+
+## Subcommands
+
+| Command | Description |
+|---------|-------------|
+| [`fontist manifest install`](#manifest-install) | Install fonts from a manifest file |
+| [`fontist manifest locations`](#manifest-locations) | Get locations of fonts from a manifest |
+
+---
+
+## manifest install
+
+Install fonts defined in a YAML manifest file.
+
+### Syntax
+
+```sh
+fontist manifest install MANIFEST [options]
+```
+
+### Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `MANIFEST` | Yes | Path to YAML manifest file |
+
+### Options
+
+| Option | Alias | Type | Description |
+|--------|-------|------|-------------|
+| `--accept-all-licenses` | `-a` | boolean | Accept all license agreements |
+| `--hide-licenses` | `-h` | boolean | Hide license texts |
+| `--location` | `-l` | string | Install location: fontist, user, or system |
+
+### Examples
+
+```sh
+# Install fonts from manifest
+fontist manifest install fonts.yml
+
+# Accept licenses automatically (for CI)
+fontist manifest install fonts.yml --accept-all-licenses --hide-licenses
+
+# Install to user directory
+fontist manifest install fonts.yml --location user
+```
+
+---
+
+## manifest locations
+
+Get the file system locations of fonts defined in a manifest.
+
+### Syntax
+
+```sh
+fontist manifest locations MANIFEST [options]
+```
+
+### Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `MANIFEST` | Yes | Path to YAML manifest file |
+
+### Options
+
+| Option | Alias | Type | Description |
+|--------|-------|------|-------------|
+| `--show-timing` | `-t` | boolean | Show timing information for manifest resolution |
+
+### Examples
+
+```sh
+# Get font paths from manifest
+fontist manifest locations fonts.yml
+
+# Show timing information
+fontist manifest locations fonts.yml --show-timing
+```
+
+---
+
+## Manifest File Format
+
+A manifest is a YAML file listing required fonts:
+
+```yaml
+# Simple font list
+Roboto:
+Source Sans Pro:
+Fira Code:
+```
+
+```yaml
+# With specific styles
+Roboto:
+  - Regular
+  - Bold
+  - Italic
+```
+
+## Use Cases
+
+- **CI/CD**: Define project fonts in a manifest file for reproducible builds
+- **Team projects**: Share font requirements across team members
+- **Documentation**: Self-documenting font requirements

data/docs/cli/repo.md

@@ -0,0 +1,142 @@
+# fontist repo
+
+Manage custom font formula repositories.
+
+## Subcommands
+
+| Command | Description |
+|---------|-------------|
+| [`fontist repo setup`](#repo-setup) | Setup a custom repository |
+| [`fontist repo update`](#repo-update) | Update a custom repository |
+| [`fontist repo remove`](#repo-remove) | Remove a custom repository |
+| [`fontist repo list`](#repo-list) | List all repositories |
+| [`fontist repo info`](#repo-info) | Show repository information |
+
+---
+
+## repo setup
+
+Setup a custom fontist formula repository.
+
+### Syntax
+
+```sh
+fontist repo setup NAME URL
+```
+
+### Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `NAME` | Yes | Local name for the repository |
+| `URL` | Yes | Git repository URL |
+
+### Examples
+
+```sh
+# Setup a custom repository
+fontist repo setup my-fonts https://github.com/myorg/font-formulas
+
+# Setup from a private repository
+fontist repo setup company git@github.com:company/font-formulas.git
+```
+
+---
+
+## repo update
+
+Update formulas in a custom repository.
+
+### Syntax
+
+```sh
+fontist repo update NAME
+```
+
+### Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `NAME` | Yes | Repository name |
+
+### Examples
+
+```sh
+fontist repo update my-fonts
+```
+
+---
+
+## repo remove
+
+Remove a custom repository.
+
+### Syntax
+
+```sh
+fontist repo remove NAME
+```
+
+### Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `NAME` | Yes | Repository name |
+
+### Examples
+
+```sh
+fontist repo remove my-fonts
+```
+
+---
+
+## repo list
+
+List all configured repositories.
+
+### Syntax
+
+```sh
+fontist repo list
+```
+
+### Examples
+
+```sh
+fontist repo list
+```
+
+---
+
+## repo info
+
+Show information about a repository.
+
+### Syntax
+
+```sh
+fontist repo info NAME
+```
+
+### Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `NAME` | Yes | Repository name |
+
+### Examples
+
+```sh
+fontist repo info my-fonts
+```
+
+---
+
+## Use Cases
+
+Custom repositories are useful for:
+
+- **Private fonts**: Host formulas for proprietary fonts
+- **Organization-specific**: Share fonts within an organization
+- **Testing**: Test new formulas before contributing upstream

data/docs/cli/status.md

@@ -0,0 +1,39 @@
+# fontist status
+
+Show paths of installed fonts on your system.
+
+## Syntax
+
+```sh
+fontist status [FONT]
+```
+
+## Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `FONT` | No | Optional font name to filter results |
+
+## Examples
+
+```sh
+# Show all installed fonts on the system
+fontist status
+
+# Show paths for a specific font
+fontist status "Open Sans"
+```
+
+## System Font Detection
+
+The `status` command searches **all fonts available on your system**, including:
+- Fonts installed by Fontist
+- System fonts (Windows, macOS, Linux)
+- User-installed fonts
+
+This is useful to see if a font you need is already available before installing it with Fontist.
+
+## Related Commands
+
+- [fontist install](/cli/install) - Install fonts
+- [fontist list](/cli/list) - List available and installed fonts

data/docs/cli/uninstall.md

@@ -0,0 +1,34 @@
+# fontist uninstall
+
+Uninstall fonts that were installed by Fontist.
+
+## Syntax
+
+```sh
+fontist uninstall FONT
+```
+
+## Aliases
+
+- `fontist remove` - Same as uninstall
+
+## Arguments
+
+| Name | Required | Description |
+|------|----------|-------------|
+| `FONT` | Yes | Font or formula name to uninstall |
+
+## Examples
+
+```sh
+# Uninstall a specific font
+fontist uninstall "Roboto"
+
+# Using the remove alias
+fontist remove "Open Sans"
+```
+
+## Related Commands
+
+- [fontist install](/cli/install) - Install fonts
+- [fontist status](/cli/status) - Show installed font paths

data/docs/cli/update.md

@@ -0,0 +1,31 @@
+# fontist update
+
+Update the Fontist formulas repository.
+
+## Syntax
+
+```sh
+fontist update
+```
+
+## Description
+
+Updates the formulas repository to get the latest font definitions. This downloads new and updated formulas from the official Fontist formulas repository.
+
+## Examples
+
+```sh
+# Update formulas
+fontist update
+```
+
+## When to Update
+
+Run this command when:
+- You can't find a font that should be available
+- After a while to get new fonts added to the repository
+- When instructed by error messages
+
+## Related Commands
+
+- [fontist version](/cli/version) - Show version information