@sp-days-framework/create-sp-days 1.0.4 → 1.1.0-beta1

package/templates/addon-resources/resources/cheat-sheet.mdx

@@ -0,0 +1,120 @@
+---
+sidebar_label: "Cheat Sheet"
+sidebar_custom_props:
+  section: "Templates"
+  section_position: 1
+---
+
+{/*
+
+Cheat Sheets provide concise, quick-reference information for the most common commands and patterns. 
+Focus on practical, copy-paste ready examples without extensive explanation. Keep it brief – use 
+CLI Reference for comprehensive documentation.
+
+*/}
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Cheat Sheet Template
+
+Quick reference for the most commonly used commands and patterns.
+
+## Basic Operations
+
+```bash
+# List all items
+command list
+
+# Show detailed information
+command info <name>
+
+# Create new item
+command create <name>
+
+# Delete an item
+command delete <name>
+```
+
+## Common Options
+
+| Option        | Description                          | Example                    |
+|---------------|--------------------------------------|----------------------------|
+| `-v, --verbose` | Enable verbose output              | `command -v list`          |
+| `-o, --output`  | Specify output format (json/yaml)  | `command -o json list`     |
+| `-f, --force`   | Skip confirmation prompts          | `command -f delete <name>` |
+| `-h, --help`    | Show help information              | `command -h`               |
+
+## Working with Configuration
+
+```bash
+# View current configuration
+command config show
+
+# Set a configuration value
+command config set key=value
+
+# Reset to defaults
+command config reset
+```
+
+## Filtering and Searching
+
+```bash
+# Filter by status
+command list --status active
+
+# Search by name
+command list --name "search-term"
+
+# Combine multiple filters
+command list --status active --tag production
+```
+
+## Output Formatting
+
+<Tabs>
+<TabItem value="json" label="JSON">
+
+**JSON Output**
+
+```bash
+command list --output json
+```
+
+</TabItem>
+<TabItem value="yaml" label="YAML">
+
+**YAML Output**
+
+```bash
+command list --output yaml
+```
+
+</TabItem>
+<TabItem value="table" label="Table">
+
+**Table Output**
+
+```bash
+command list --output table
+```
+
+</TabItem>
+</Tabs>
+
+## Advanced Usage
+
+```bash
+# Batch operations
+command delete item1 item2 item3
+
+# Watch mode (continuous updates)
+command watch list
+
+# Export data
+command export --format json > backup.json
+
+# Import data
+command import backup.json
+```

package/templates/addon-resources/resources/cli-reference.mdx

@@ -0,0 +1,280 @@
+---
+sidebar_label: "CLI Reference"
+sidebar_custom_props:
+  section: "Templates"
+  section_position: 1
+---
+
+{/*
+
+CLI Reference pages provide comprehensive documentation for command-line tools, including all 
+commands, subcommands, options, and flags. Organize by command hierarchy and include detailed 
+explanations of each option's behavior.
+
+*/}
+
+# CLI Reference Template
+
+Complete reference for all command-line interface commands, options, and usage patterns.
+
+## Global Options
+
+These options are available for all commands:
+
+| Option             | Description                              |
+|--------------------|------------------------------------------|
+| `--version`        | Display version information              |
+| `--help, -h`       | Show help for any command                |
+| `--verbose, -v`    | Enable verbose output                    |
+| `--quiet, -q`      | Suppress non-error output                |
+| `--config <path>`  | Specify custom configuration file path   |
+| `--output, -o <format>` | Output format: `json`, `yaml`, `table` |
+
+## Commands
+
+### `init`
+
+Initialize a new project or configuration.
+
+**Usage:**
+
+```bash
+command init [options]
+```
+
+**Options:**
+
+| Option              | Description                           | Default    |
+|---------------------|---------------------------------------|------------|
+| `--name <name>`     | Project name                          | Current directory name |
+| `--template <type>` | Template to use (`basic`, `advanced`) | `basic`    |
+| `--force, -f`       | Overwrite existing files              | `false`    |
+
+**Examples:**
+
+```bash
+# Initialize with defaults
+command init
+
+# Initialize with custom name and template
+command init --name my-project --template advanced
+
+# Force initialization (overwrite existing)
+command init --force
+```
+
+### `create`
+
+Create a new resource.
+
+**Usage:**
+
+```bash
+command create <resource-type> <name> [options]
+```
+
+**Parameters:**
+
+| Parameter         | Type     | Required | Description                          | Default |
+|-------------------|----------|----------|--------------------------------------|---------|
+| `resource-type`   | argument | Yes      | Type of resource to create           | -       |
+| `name`            | argument | Yes      | Name for the new resource            | -       |
+| `--description <text>` | option | No  | Resource description                 | -       |
+| `--tags <tags>`   | option   | No       | Comma-separated tags                 | -       |
+| `--public`        | option   | No       | Make resource publicly accessible    | `false` |
+
+**Examples:**
+
+```bash
+# Create a basic resource
+command create item my-item
+
+# Create with description and tags
+command create item my-item --description "Sample item" --tags "tag1,tag2"
+```
+
+### `list`
+
+Display a list of resources.
+
+**Usage:**
+
+```bash
+command list [resource-type] [options]
+```
+
+**Options:**
+
+| Option                  | Description                        | Default |
+|-------------------------|------------------------------------|---------|
+| `--filter <expression>` | Filter results by criteria         | -       |
+| `--sort <field>`        | Sort by field (`name`, `date`)     | `name`  |
+| `--limit <number>`      | Maximum number of results          | `50`    |
+| `--all, -a`             | Show all items (including archived)| `false` |
+
+**Examples:**
+
+```bash
+# List all resources
+command list
+
+# List with filters
+command list --filter "status=active" --sort date
+
+# List all including archived
+command list --all
+```
+
+### `update`
+
+Update an existing resource.
+
+**Usage:**
+
+```bash
+command update <resource-id> [options]
+```
+
+**Parameters:**
+
+| Parameter         | Type     | Required | Description                  |
+|-------------------|----------|----------|------------------------------|
+| `resource-id`     | argument | Yes      | ID of resource to update     |
+| `--name <name>`   | option   | No       | Update resource name         |
+| `--description <text>` | option | No  | Update description           |
+| `--tags <tags>`   | option   | No       | Update tags (overwrites all) |
+| `--add-tag <tag>` | option   | No       | Add a single tag             |
+| `--remove-tag <tag>` | option | No    | Remove a single tag          |
+
+**Examples:**
+
+```bash
+# Update name
+command update 123 --name "New Name"
+
+# Add tags
+command update 123 --add-tag production --add-tag critical
+```
+
+### `delete`
+
+Delete one or more resources.
+
+**Usage:**
+
+```bash
+command delete <resource-id>... [options]
+```
+
+**Parameters:**
+
+| Parameter         | Type     | Required | Description                        | Default |
+|-------------------|----------|----------|------------------------------------|---------|
+| `resource-id`     | argument | Yes      | One or more resource IDs to delete | -       |
+| `--force, -f`     | option   | No       | Skip confirmation prompt           | `false` |
+| `--recursive, -r` | option   | No       | Delete related resources           | `false` |
+
+**Examples:**
+
+```bash
+# Delete single resource (with confirmation)
+command delete 123
+
+# Delete multiple resources without confirmation
+command delete 123 456 789 --force
+
+# Delete with related resources
+command delete 123 --recursive
+```
+
+### `config`
+
+Manage configuration settings.
+
+**Usage:**
+
+```bash
+command config <action> [options]
+```
+
+**Subcommands:**
+
+#### `config get`
+
+Retrieve configuration value(s).
+
+```bash
+command config get [key]
+```
+
+#### `config set`
+
+Set configuration value.
+
+```bash
+command config set <key> <value>
+```
+
+#### `config list`
+
+List all configuration settings.
+
+```bash
+command config list
+```
+
+#### `config reset`
+
+Reset configuration to defaults.
+
+```bash
+command config reset [--confirm]
+```
+
+**Examples:**
+
+```bash
+# Get specific value
+command config get api.endpoint
+
+# Set a value
+command config set api.timeout 30
+
+# View all settings
+command config list
+
+# Reset to defaults
+command config reset --confirm
+```
+
+## Environment Variables
+
+| Variable           | Description                      | Default         |
+|--------------------|----------------------------------|-----------------|
+| `COMMAND_API_KEY`  | API authentication key           | -               |
+| `COMMAND_ENDPOINT` | API endpoint URL                 | `https://api.example.com` |
+| `COMMAND_TIMEOUT`  | Request timeout in seconds       | `30`            |
+| `COMMAND_LOG_LEVEL`| Logging level (`debug`, `info`, `error`) | `info` |
+
+## Exit Codes
+
+| Code | Description                          |
+|------|--------------------------------------|
+| 0    | Success                              |
+| 1    | General error                        |
+| 2    | Invalid arguments or options         |
+| 3    | Resource not found                   |
+| 4    | Permission denied                    |
+| 130  | Command interrupted (Ctrl+C)         |
+
+:::tip Shell Completion
+Enable shell completion for better command-line experience:
+
+```bash
+# Bash
+command completion bash > /etc/bash_completion.d/command
+
+# Zsh
+command completion zsh > ~/.zsh/completion/_command
+```
+:::

package/templates/addon-resources/resources/configuration-guide.mdx

@@ -0,0 +1,211 @@
+---
+sidebar_label: "Configuration Guide"
+sidebar_custom_props:
+  section: "Templates"
+  section_position: 1
+---
+
+{/*
+
+Configuration Guide pages explain how to configure and customize the technology through 
+configuration files, environment variables, or settings. Include complete, working examples 
+with explanations of key parameters and their effects.
+
+*/}
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Configuration Guide Template
+
+Learn how to configure and customize settings to meet your specific requirements.
+
+## Configuration File Location
+
+Configuration files are typically located in:
+
+- **Project-level:** `./config.yml` or `./.config.yml`
+- **User-level:** `~/.config/app/config.yml`
+- **System-level:** `/etc/app/config.yml`
+
+Configuration is loaded in order of precedence: project → user → system.
+
+## Basic Configuration
+
+<Tabs>
+<TabItem value="yaml" label="YAML">
+
+```yaml title="config.yml"
+# Basic configuration example
+app:
+  name: my-application
+  version: 1.0.0
+  environment: development
+
+server:
+  host: localhost
+  port: 8080
+  timeout: 30
+
+logging:
+  level: info
+  format: json
+  output: stdout
+```
+
+</TabItem>
+<TabItem value="json" label="JSON">
+
+```json title="config.json"
+{
+  "app": {
+    "name": "my-application",
+    "version": "1.0.0",
+    "environment": "development"
+  },
+  "server": {
+    "host": "localhost",
+    "port": 8080,
+    "timeout": 30
+  },
+  "logging": {
+    "level": "info",
+    "format": "json",
+    "output": "stdout"
+  }
+}
+```
+
+</TabItem>
+</Tabs>
+
+## Configuration Parameters
+
+### Application Settings
+
+| Parameter         | Type    | Default     | Description                          |
+|-------------------|---------|-------------|--------------------------------------|
+| `app.name`        | string  | -           | Application name                     |
+| `app.version`     | string  | -           | Application version                  |
+| `app.environment` | string  | `production`| Environment: `development`, `staging`, `production` |
+| `app.debug`       | boolean | `false`     | Enable debug mode                    |
+
+### Server Configuration
+
+| Parameter        | Type    | Default     | Description                           |
+|------------------|---------|-------------|---------------------------------------|
+| `server.host`    | string  | `0.0.0.0`   | Server bind address                   |
+| `server.port`    | integer | `8080`      | Server port number                    |
+| `server.timeout` | integer | `30`        | Request timeout in seconds            |
+| `server.tls`     | boolean | `false`     | Enable TLS/HTTPS                      |
+
+
+## Advanced Configuration
+
+### Database Connection
+
+```yaml title="config.yml"
+database:
+  driver: postgresql
+  host: db.example.com
+  port: 5432
+  name: myapp_db
+  username: dbuser
+  password: ${DB_PASSWORD}  # Use environment variable
+  pool:
+    min: 5
+    max: 20
+    idle_timeout: 300
+```
+
+### Feature Flags
+
+```yaml title="config.yml"
+features:
+  new_ui: true
+  beta_api: false
+  experimental_cache: false
+  analytics:
+    enabled: true
+    provider: google-analytics
+    tracking_id: UA-XXXXX-Y
+```
+
+## Environment Variables
+
+Configuration values can be overridden using environment variables:
+
+| Environment Variable    | Configuration Path    | Example                  |
+|-------------------------|-----------------------|--------------------------|
+| `APP_NAME`              | `app.name`            | `APP_NAME=my-app`        |
+| `APP_ENVIRONMENT`       | `app.environment`     | `APP_ENVIRONMENT=prod`   |
+| `SERVER_PORT`           | `server.port`         | `SERVER_PORT=9000`       |
+| `LOG_LEVEL`             | `logging.level`       | `LOG_LEVEL=debug`        |
+| `DB_HOST`               | `database.host`       | `DB_HOST=db.prod.com`    |
+
+**Example:**
+
+```bash
+# Override configuration with environment variables
+export SERVER_PORT=9000
+export LOG_LEVEL=debug
+./app start
+```
+
+## Configuration Validation
+
+Validate your configuration file before deploying:
+
+```bash
+# Check configuration syntax
+command config validate
+
+# Test configuration with dry-run
+command start --dry-run
+
+# Show effective configuration (with overrides)
+command config show
+```
+
+## Common Patterns
+
+### Using Configuration Templates
+
+```yaml title="config.template.yml"
+# Copy this file to config.yml and customize
+app:
+  name: ${APP_NAME:my-app}  # Default: my-app
+  environment: ${ENVIRONMENT:development}
+
+database:
+  host: ${DB_HOST:localhost}
+  password: ${DB_PASSWORD}  # Required, no default
+```
+
+### Splitting Configuration
+
+```yaml title="config.yml"
+# Main configuration file
+includes:
+  - ./config/database.yml
+  - ./config/logging.yml
+  - ./config/features.yml
+
+app:
+  name: my-application
+```
+
+```yaml title="config/database.yml"
+database:
+  driver: postgresql
+  host: localhost
+  port: 5432
+```
+
+:::tip Configuration Best Practices
+- Use environment variables for environment-specific values
+- Keep configuration files in version control (except secrets)
+- Document all configuration options with comments
+- Validate configuration on application startup
+- Use separate configs for development, staging, and production
+:::