chore: update
This commit is contained in:
parent
6c46596cb3
commit
623fef40a4
1
.gitignore
vendored
1
.gitignore
vendored
@ -12,6 +12,7 @@ CLAUDE.md
|
||||
.wrks
|
||||
ROOT
|
||||
OLD
|
||||
old-config
|
||||
plugins/nushell-plugins
|
||||
# Generated by Cargo
|
||||
# will have compiled files and executables
|
||||
|
||||
@ -102,6 +102,17 @@ repos:
|
||||
types: [markdown]
|
||||
stages: [pre-commit]
|
||||
|
||||
# NOTE: Disabled - markdownlint-cli2 already catches syntax issues
|
||||
# This script is redundant and causing false positives
|
||||
# - id: check-malformed-fences
|
||||
# name: Check malformed closing fences
|
||||
# entry: bash -c 'cd .. && nu scripts/check-malformed-fences.nu $(git diff --cached --name-only --diff-filter=ACM | grep "\.md$" | grep -v ".coder/" | grep -v ".claude/" | grep -v "old_config/" | tr "\n" " ")'
|
||||
# language: system
|
||||
# types: [markdown]
|
||||
# pass_filenames: false
|
||||
# stages: [pre-commit]
|
||||
# exclude: ^\.coder/|^\.claude/|^old_config/
|
||||
|
||||
# ============================================================================
|
||||
# General Pre-commit Hooks
|
||||
# ============================================================================
|
||||
|
||||
42
README.md
42
README.md
@ -49,7 +49,7 @@ provisioning/core/
|
||||
├── scripts/ # Utility scripts
|
||||
│ └── test/ # Test automation
|
||||
└── resources/ # Images and logos
|
||||
```plaintext
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
@ -70,14 +70,14 @@ ln -sf "$(pwd)/provisioning/core/cli/provisioning" /usr/local/bin/provisioning
|
||||
|
||||
# Or add to PATH in your shell config (~/.bashrc, ~/.zshrc, etc.)
|
||||
export PATH="$PATH:/path/to/project-provisioning/provisioning/core/cli"
|
||||
```plaintext
|
||||
```
|
||||
|
||||
Verify installation:
|
||||
|
||||
```bash
|
||||
provisioning version
|
||||
provisioning help
|
||||
```plaintext
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
@ -99,7 +99,7 @@ provisioning providers
|
||||
|
||||
# Show system information
|
||||
provisioning nuinfo
|
||||
```plaintext
|
||||
```
|
||||
|
||||
### Infrastructure Operations
|
||||
|
||||
@ -118,7 +118,7 @@ provisioning cluster create my-cluster
|
||||
|
||||
# SSH into server
|
||||
provisioning server ssh hostname-01
|
||||
```plaintext
|
||||
```
|
||||
|
||||
### Quick Reference
|
||||
|
||||
@ -126,7 +126,7 @@ For fastest command reference:
|
||||
|
||||
```bash
|
||||
provisioning sc
|
||||
```plaintext
|
||||
```
|
||||
|
||||
For complete guides:
|
||||
|
||||
@ -134,7 +134,7 @@ For complete guides:
|
||||
provisioning guide from-scratch # Complete deployment guide
|
||||
provisioning guide quickstart # Command shortcuts reference
|
||||
provisioning guide customize # Customization patterns
|
||||
```plaintext
|
||||
```
|
||||
|
||||
## Core Libraries
|
||||
|
||||
@ -154,7 +154,7 @@ let value = config get "servers.default_plan"
|
||||
|
||||
# Load workspace config
|
||||
let ws_config = config load-workspace "my-project"
|
||||
```plaintext
|
||||
```
|
||||
|
||||
### Provider Abstraction (`lib_provisioning/providers/`)
|
||||
|
||||
@ -168,7 +168,7 @@ let provider = providers get "upcloud"
|
||||
|
||||
# Create server using provider
|
||||
$provider | invoke "create_server" $server_config
|
||||
```plaintext
|
||||
```
|
||||
|
||||
### Utilities (`lib_provisioning/utils/`)
|
||||
|
||||
@ -197,7 +197,7 @@ provisioning workflow list
|
||||
|
||||
# Get workflow status
|
||||
provisioning workflow status <id>
|
||||
```plaintext
|
||||
```
|
||||
|
||||
## CLI Architecture
|
||||
|
||||
@ -217,7 +217,7 @@ The CLI uses a domain-driven architecture:
|
||||
80+ shortcuts for improved productivity:
|
||||
|
||||
| Full Command | Shortcuts | Description |
|
||||
|--------------|-----------|-------------|
|
||||
| ------------ | --------- | ----------- |
|
||||
| `server` | `s` | Server operations |
|
||||
| `taskserv` | `t`, `task` | Task service operations |
|
||||
| `cluster` | `cl` | Cluster operations |
|
||||
@ -238,7 +238,7 @@ Help works in both directions:
|
||||
provisioning help workspace # ✅
|
||||
provisioning workspace help # ✅ Same result
|
||||
provisioning ws help # ✅ Shortcut also works
|
||||
```plaintext
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -264,7 +264,7 @@ provisioning allenv
|
||||
|
||||
# Use specific environment
|
||||
PROVISIONING_ENV=prod provisioning server list
|
||||
```plaintext
|
||||
```
|
||||
|
||||
### Debug Flags
|
||||
|
||||
@ -280,7 +280,7 @@ provisioning --yes cluster delete
|
||||
|
||||
# Specify infrastructure
|
||||
provisioning --infra my-project server list
|
||||
```plaintext
|
||||
```
|
||||
|
||||
## Design Principles
|
||||
|
||||
@ -377,7 +377,7 @@ nu provisioning/core/scripts/test/test_all.nu
|
||||
# Run specific test group
|
||||
nu provisioning/core/scripts/test/test_config.nu
|
||||
nu provisioning/core/scripts/test/test_cli.nu
|
||||
```plaintext
|
||||
```
|
||||
|
||||
### Test Coverage
|
||||
|
||||
@ -408,7 +408,7 @@ When contributing to the Core Engine:
|
||||
```bash
|
||||
provisioning env # Check current configuration
|
||||
provisioning validate config # Validate configuration files
|
||||
```plaintext
|
||||
```
|
||||
|
||||
**Nickel schema errors:**
|
||||
|
||||
@ -416,14 +416,14 @@ provisioning validate config # Validate configuration files
|
||||
nickel fmt <file>.ncl # Format Nickel file
|
||||
nickel eval <file>.ncl # Evaluate Nickel schema
|
||||
nickel typecheck <file>.ncl # Type check schema
|
||||
```plaintext
|
||||
```
|
||||
|
||||
**Provider authentication:**
|
||||
|
||||
```bash
|
||||
provisioning providers # List available providers
|
||||
provisioning show settings # View provider configuration
|
||||
```plaintext
|
||||
```
|
||||
|
||||
### Debug Mode
|
||||
|
||||
@ -431,7 +431,7 @@ Enable verbose logging:
|
||||
|
||||
```bash
|
||||
provisioning --debug <command>
|
||||
```plaintext
|
||||
```
|
||||
|
||||
### Getting Help
|
||||
|
||||
@ -440,7 +440,7 @@ provisioning help # Show main help
|
||||
provisioning help <category> # Category-specific help
|
||||
provisioning <command> help # Command-specific help
|
||||
provisioning guide list # List all guides
|
||||
```plaintext
|
||||
```
|
||||
|
||||
## Version Information
|
||||
|
||||
@ -449,7 +449,7 @@ Check system versions:
|
||||
```bash
|
||||
provisioning version # Show all versions
|
||||
provisioning nuinfo # Nushell information
|
||||
```plaintext
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user