76332b0f02
* docs: add user guide, faq, and enhance troubleshooting - Created docs/user-guide.md with key concepts and workflows. - Created docs/faq.md with common questions and answers. - Enhanced docs/troubleshooting.md with AI/Agentic issues. - Updated README.md with CLI Quick Start and Getting Help sections. - Refactored mkdocs.yml to reflect actual file structure and include new docs. * docs: add user documentation and fix mkdocs navigation - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md with AI/Agentic issues. - Updated README.md with CLI Quick Start and Help links. - Restored original mkdocs.yml navigation and added new user documentation sections. - Fixed formatting in pkg/io/local/client.go to ensure CI passes. * docs: add user documentation and fix auto-merge workflow - Created docs/user-guide.md and docs/faq.md with user-focused content. - Enhanced docs/troubleshooting.md with AI/Agentic issue solutions. - Updated README.md with CLI Quick Start and organized help links. - Refactored mkdocs.yml to include new documentation while preserving technical sections. - Fixed .github/workflows/auto-merge.yml by inlining the logic and adding git repository context (checkout and -R flag) to resolve CI failures. - Verified that docs/workflows.md is present in the repository. * docs: add user documentation and resolve merge conflict - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md with AI/Agentic issue solutions. - Updated README.md with CLI Quick Start and Help sections. - Merged latest base branch changes and resolved conflict in .github/workflows/auto-merge.yml. - Verified and organized mkdocs.yml navigation. * docs: add user documentation and fix UniFi security issue - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md. - Updated README.md with CLI Quick Start. - Fixed UniFi security vulnerability (CodeQL alert) by making TLS verification configurable. - Added --insecure flag to UniFi CLI commands. - Verified all documentation links and navigation. * docs: add user documentation and fix formatting/security - Created docs/user-guide.md and docs/faq.md. - Enhanced docs/troubleshooting.md. - Updated README.md with CLI Quick Start. - Fixed UniFi security vulnerability by making TLS verification configurable. - Added --insecure flag to UniFi CLI commands. - Fixed formatting in internal/cmd/unifi/cmd_config.go. - Verified all documentation links and navigation. --------- Co-authored-by: Claude <developers@lethean.io>
100 lines
2.5 KiB
Markdown
100 lines
2.5 KiB
Markdown
# User Guide
|
|
|
|
This guide provides a comprehensive overview of how to use the Core CLI to manage your development workflow.
|
|
|
|
## Key Concepts
|
|
|
|
### Projects
|
|
A Project is a single repository containing code (Go, PHP, or Wails). Core helps you test, build, and release these projects using a consistent set of commands.
|
|
|
|
### Workspaces
|
|
A Workspace is a collection of related projects. Core is designed to work across multiple repositories, allowing you to perform actions (like checking status or committing changes) on all of them at once.
|
|
|
|
### Registry (`repos.yaml`)
|
|
The Registry is a configuration file that defines the repositories in your workspace. It includes information about where they are located on GitHub, their dependencies, and their purpose.
|
|
|
|
---
|
|
|
|
## Daily Workflow
|
|
|
|
### Working with a Single Project
|
|
|
|
For a typical day-to-day development on a single project:
|
|
|
|
1. **Verify your environment**:
|
|
```bash
|
|
core doctor
|
|
```
|
|
2. **Run tests while you work**:
|
|
```bash
|
|
core go test
|
|
```
|
|
3. **Keep code clean**:
|
|
```bash
|
|
core go fmt --fix
|
|
core go lint
|
|
```
|
|
4. **Build and preview**:
|
|
```bash
|
|
core build
|
|
```
|
|
|
|
### Working with Multiple Repositories
|
|
|
|
If you are working across many repositories in a workspace:
|
|
|
|
1. **Check status of all repos**:
|
|
```bash
|
|
core dev work --status
|
|
```
|
|
2. **Sync all changes**:
|
|
```bash
|
|
core dev pull --all
|
|
```
|
|
3. **Commit and push everything**:
|
|
```bash
|
|
core dev work
|
|
```
|
|
|
|
---
|
|
|
|
## Building and Releasing
|
|
|
|
Core separates the building of artifacts from the releasing of those artifacts.
|
|
|
|
### 1. Build
|
|
The `core build` command detects your project type and builds binaries for your configured targets. Artifacts are placed in the `dist/` directory.
|
|
|
|
### 2. Preview Release
|
|
Use `core ci` to see a summary of what would be included in a release (changelog, artifacts, etc.). This is a dry-run by default.
|
|
|
|
### 3. Publish Release
|
|
When you are ready to publish to GitHub:
|
|
```bash
|
|
core ci --we-are-go-for-launch
|
|
```
|
|
|
|
---
|
|
|
|
## PHP and Laravel Development
|
|
|
|
Core provides a unified development server for Laravel projects that orchestrates several services:
|
|
|
|
```bash
|
|
core php dev
|
|
```
|
|
This starts FrankenPHP, Vite, Horizon, Reverb, and Redis as configured in your `.core/php.yaml`.
|
|
|
|
---
|
|
|
|
## Common Workflows
|
|
|
|
For detailed examples of common end-to-end workflows, see the [Workflows](workflows.md) page.
|
|
|
|
---
|
|
|
|
## Getting More Help
|
|
|
|
- Use the `--help` flag with any command: `core build --help`
|
|
- Check the [FAQ](faq.md) for common questions.
|
|
- If you run into trouble, see the [Troubleshooting Guide](troubleshooting.md).
|