Some checks are pending
Bidi Control Character Guard / bidi-control-guard (push) Waiting to run
Circular Dependency Check / Check for new circular dependencies (push) Waiting to run
Citus Migration Smoke / Combined migrations on single-node Citus (push) Waiting to run
E2E Fresh Install Tests / fresh-install-e2e (push) Waiting to run
ext-v2 guardrails / Run ext-v2 guard and ESLint (push) Waiting to run
Integration Tests / Check for relevant changes (push) Waiting to run
Integration Tests / ${{ (github.event_name == 'schedule' || github.event.inputs.suite == 'full') && 'Full integration suite' || 'Tier-1 integration subset' }} (push) Blocked by required conditions
Mobile checks / Mobile lint + typecheck (push) Waiting to run
Mobile checks / Mobile unit tests (push) Waiting to run
Mobile checks / Mobile dependency audit (report) (push) Waiting to run
Mobile checks / Mobile reproducibility checks (push) Waiting to run
Secrets guard (env backups) / Ensure no tracked env backup files (push) Waiting to run
Temporal Readiness / fast-readiness (push) Waiting to run
Temporal Readiness / docker-parity (push) Waiting to run
TypeScript Type Check / Nx affected typecheck (push) Waiting to run
Unit Tests / Skipped-test budget (push) Waiting to run
Unit Tests / Nx affected unit tests (push) Waiting to run
Unit Tests / Server unit coverage (informational) (push) Waiting to run
Validate Tenant Management Schema / Check for relevant changes (push) Waiting to run
Validate Tenant Management Schema / Validate Tenant Management Schema (push) Blocked by required conditions
EE Workflows Build Guard / ee-workflows-build-guard (push) Waiting to run
Excluded: .git, node_modules, secrets/, compose.env, assemblyscript tgz Source: /opt/alga-psa on psa.joliet.tech
105 lines
2.6 KiB
Markdown
105 lines
2.6 KiB
Markdown
# Alga CLI Configuration
|
|
|
|
The Alga CLI now supports a configuration file to store user preferences and defaults, eliminating the need to repeatedly specify common options.
|
|
|
|
## Configuration File Location
|
|
|
|
The configuration file is stored at:
|
|
- Linux/macOS: `~/.config/alga-cli/config.toml`
|
|
- Or respects `$XDG_CONFIG_HOME` if set: `$XDG_CONFIG_HOME/alga-cli/config.toml`
|
|
|
|
## Quick Start
|
|
|
|
Initialize your configuration:
|
|
```bash
|
|
nu cli/main.nu config init
|
|
```
|
|
|
|
This will prompt you for:
|
|
- Your git author name
|
|
- Your git author email
|
|
- Default edition preference (ce/ee)
|
|
|
|
## Configuration Commands
|
|
|
|
### Initialize Configuration
|
|
```bash
|
|
nu cli/main.nu config init [--force]
|
|
```
|
|
Creates a new configuration file with prompts. Use `--force` to overwrite existing config.
|
|
|
|
### Show Configuration
|
|
```bash
|
|
nu cli/main.nu config show
|
|
```
|
|
Displays the current configuration and file location.
|
|
|
|
### Get Configuration Value
|
|
```bash
|
|
nu cli/main.nu config get <key>
|
|
```
|
|
Examples:
|
|
```bash
|
|
nu cli/main.nu config get dev_env.author.name
|
|
nu cli/main.nu config get dev_env.author.email
|
|
nu cli/main.nu config get dev_env.default_edition
|
|
```
|
|
|
|
### Set Configuration Value
|
|
```bash
|
|
nu cli/main.nu config set <key> <value>
|
|
```
|
|
Examples:
|
|
```bash
|
|
nu cli/main.nu config set dev_env.author.name "John Doe"
|
|
nu cli/main.nu config set dev_env.author.email "john@example.com"
|
|
nu cli/main.nu config set dev_env.default_edition "ee"
|
|
```
|
|
|
|
## Configuration Structure
|
|
|
|
The configuration file uses TOML format:
|
|
|
|
```toml
|
|
version = "1.0"
|
|
|
|
[dev_env]
|
|
default_edition = "ee"
|
|
|
|
[dev_env.author]
|
|
name = "John Doe"
|
|
email = "john@example.com"
|
|
```
|
|
|
|
## Using Configuration with dev-env-create
|
|
|
|
When creating a development environment, the CLI will use your configured author information by default:
|
|
|
|
```bash
|
|
# Uses author info from config
|
|
nu cli/main.nu dev-env-create my-feature
|
|
|
|
# Override config with command-line options
|
|
nu cli/main.nu dev-env-create my-feature --author-name "Jane Doe" --author-email "jane@example.com"
|
|
```
|
|
|
|
If author information is loaded from config, you'll see a message:
|
|
```
|
|
Using git author from config: John Doe <john@example.com>
|
|
```
|
|
|
|
## Priority Order
|
|
|
|
The CLI uses the following priority for git author information:
|
|
1. Command-line parameters (`--author-name`, `--author-email`)
|
|
2. Configuration file values
|
|
3. Default values ("Dev Environment" <dev@alga.local>)
|
|
|
|
## Future Configuration Options
|
|
|
|
The configuration system is designed to be extensible. Future options may include:
|
|
- Default Kubernetes namespace patterns
|
|
- Preferred external port ranges
|
|
- Custom repository URLs
|
|
- Build and deployment preferences
|
|
- AI automation settings |