@mohammadhprp/system-prompt 0.12.0 → 0.12.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/framework/agents/README.md +0 -1
- package/framework/commands/mr.md +8 -9
- package/framework/mcps/README.md +0 -3
- package/framework/skills/README.md +5 -4
- package/framework/skills/effective-html/SKILL.md +63 -0
- package/framework/skills/effective-html/examples.md +19 -0
- package/framework/skills/effective-html/references/charts-and-data.md +32 -0
- package/framework/skills/effective-html/references/creative-direction.md +48 -0
- package/framework/skills/effective-html/references/design-artifact.md +78 -0
- package/framework/skills/effective-html/references/diagrams.md +68 -0
- package/framework/skills/effective-html/references/documents-and-presentations.md +28 -0
- package/framework/skills/effective-html/references/html-diagram.md +43 -0
- package/framework/skills/effective-html/references/html-plan.md +40 -0
- package/framework/skills/effective-html/references/html-prototype.md +97 -0
- package/framework/skills/effective-html/references/html-wireframe.md +81 -0
- package/framework/skills/effective-html/references/html.md +72 -0
- package/framework/skills/effective-html/references/interfaces.md +17 -0
- package/framework/skills/glab/SKILL.md +222 -0
- package/framework/skills/glab/references/commands-detailed.md +616 -0
- package/framework/skills/glab/references/quick-reference.md +145 -0
- package/framework/skills/glab/references/troubleshooting.md +669 -0
- package/framework/skills/great-interface/SKILL.md +43 -0
- package/framework/skills/great-interface/references/animations.md +205 -0
- package/framework/skills/great-interface/references/better-accessibility.md +106 -0
- package/framework/skills/great-interface/references/better-colors.md +100 -0
- package/framework/skills/great-interface/references/better-interface.md +132 -0
- package/framework/skills/great-interface/references/better-layout.md +76 -0
- package/framework/skills/great-interface/references/better-typography.md +157 -0
- package/framework/skills/great-interface/references/better-ui.md +107 -0
- package/framework/skills/great-interface/references/better-writing.md +109 -0
- package/framework/skills/great-interface/references/choosing-fonts.md +64 -0
- package/framework/skills/great-interface/references/color-formats.md +90 -0
- package/framework/skills/great-interface/references/color-usage.md +118 -0
- package/framework/skills/great-interface/references/contrast.md +79 -0
- package/framework/skills/great-interface/references/css-cheat-sheet.md +65 -0
- package/framework/skills/great-interface/references/details-and-accessibility.md +119 -0
- package/framework/skills/great-interface/references/enter-exit.md +147 -0
- package/framework/skills/great-interface/references/explain-interface.md +126 -0
- package/framework/skills/great-interface/references/find-the-effect.md +94 -0
- package/framework/skills/great-interface/references/focus-and-keyboard.md +131 -0
- package/framework/skills/great-interface/references/forms.md +84 -0
- package/framework/skills/great-interface/references/from-an-image.md +55 -0
- package/framework/skills/great-interface/references/grouping-and-alignment.md +123 -0
- package/framework/skills/great-interface/references/hit-areas.md +94 -0
- package/framework/skills/great-interface/references/icon-transitions.md +102 -0
- package/framework/skills/great-interface/references/icons.md +110 -0
- package/framework/skills/great-interface/references/interface-review.md +148 -0
- package/framework/skills/great-interface/references/motion-and-zoom.md +79 -0
- package/framework/skills/great-interface/references/no-browser.md +73 -0
- package/framework/skills/great-interface/references/palette-generation.md +104 -0
- package/framework/skills/great-interface/references/palette-structure.md +76 -0
- package/framework/skills/great-interface/references/performance.md +88 -0
- package/framework/skills/great-interface/references/picker.md +76 -0
- package/framework/skills/great-interface/references/read-the-system.md +178 -0
- package/framework/skills/great-interface/references/removed-signals.md +38 -0
- package/framework/skills/great-interface/references/review-format.md +46 -0
- package/framework/skills/great-interface/references/scope-resolution.md +88 -0
- package/framework/skills/great-interface/references/screen-readers.md +101 -0
- package/framework/skills/great-interface/references/semantics-and-aria.md +84 -0
- package/framework/skills/great-interface/references/spacing-and-adaptivity.md +159 -0
- package/framework/skills/great-interface/references/spacing-and-sizing.md +121 -0
- package/framework/skills/great-interface/references/surfaces.md +219 -0
- package/framework/skills/great-interface/references/token-naming.md +97 -0
- package/framework/skills/great-interface/references/variable-fonts-and-opentype.md +105 -0
- package/framework/skills/great-interface/references/variant.md +104 -0
- package/framework/skills/great-interface/references/wrapping-and-punctuation.md +55 -0
- package/framework/skills/improve/SKILL.md +137 -0
- package/framework/skills/improve/examples.md +19 -0
- package/framework/skills/improve/references/audit-playbook.md +130 -0
- package/framework/skills/improve/references/closing-the-loop.md +96 -0
- package/framework/skills/improve/references/plan-template.md +197 -0
- package/framework/skills/jira-cli/SKILL.md +260 -0
- package/framework/skills/jira-cli/references/commands-detailed.md +268 -0
- package/framework/skills/jira-cli/references/quick-reference.md +111 -0
- package/framework/skills/jira-cli/references/troubleshooting.md +114 -0
- package/framework/styles/README.md +9 -4
- package/framework/styles/factory/DESIGN.md +360 -0
- package/framework/styles/factory/README.md +32 -0
- package/framework/styles/factory/assets/preview.jpg +0 -0
- package/framework/styles/huly/DESIGN.md +449 -0
- package/framework/styles/huly/README.md +32 -0
- package/framework/styles/huly/assets/preview.jpg +0 -0
- package/framework/styles/notion/DESIGN.md +423 -0
- package/framework/styles/notion/README.md +32 -0
- package/framework/styles/notion/assets/preview.jpg +0 -0
- package/package.json +1 -1
- package/src/catalog.js +8 -8
- package/framework/agents/backend-architect.md +0 -146
- package/framework/mcps/github-mcp/README.md +0 -51
- package/framework/mcps/github-mcp/capabilities.md +0 -83
- package/framework/mcps/github-mcp/configs/.env.example +0 -1
- package/framework/mcps/github-mcp/configs/opencode.json +0 -13
- package/framework/mcps/github-mcp/install.md +0 -60
- package/framework/mcps/github-mcp/troubleshooting.md +0 -79
- package/framework/mcps/gitlab-mcp/README.md +0 -53
- package/framework/mcps/gitlab-mcp/capabilities.md +0 -216
- package/framework/mcps/gitlab-mcp/configs/.env.example +0 -2
- package/framework/mcps/gitlab-mcp/configs/opencode.json +0 -13
- package/framework/mcps/gitlab-mcp/install.md +0 -99
- package/framework/mcps/gitlab-mcp/troubleshooting.md +0 -116
- package/framework/mcps/jira-mcp/README.md +0 -52
- package/framework/mcps/jira-mcp/capabilities.md +0 -79
- package/framework/mcps/jira-mcp/configs/.env.example +0 -2
- package/framework/mcps/jira-mcp/configs/opencode.json +0 -13
- package/framework/mcps/jira-mcp/install.md +0 -94
- package/framework/mcps/jira-mcp/troubleshooting.md +0 -113
- package/framework/skills/brand-guidelines/LICENSE.txt +0 -202
- package/framework/skills/brand-guidelines/SKILL.md +0 -73
- package/framework/skills/gitlab-mcp/SKILL.md +0 -83
- package/framework/skills/gitlab-mcp/examples.md +0 -31
- package/framework/skills/gitlab-mcp/references/code-review.md +0 -110
- package/framework/skills/gitlab-mcp/references/issues.md +0 -141
- package/framework/skills/gitlab-mcp/references/merge-requests.md +0 -120
- package/framework/skills/gitlab-mcp/references/pipelines.md +0 -67
- package/framework/skills/gitlab-mcp/references/search.md +0 -17
- package/framework/skills/gitlab-mcp/references/webhooks.md +0 -32
- package/framework/skills/gitlab-mcp/references/work-items.md +0 -50
- package/framework/skills/jira-mcp/SKILL.md +0 -57
- package/framework/skills/jira-mcp/examples.md +0 -31
- package/framework/skills/jira-mcp/references/comments.md +0 -27
- package/framework/skills/jira-mcp/references/issues.md +0 -97
- package/framework/skills/jira-mcp/references/projects.md +0 -39
- package/framework/skills/lavish/SKILL.md +0 -67
- package/framework/skills/lavish/examples.md +0 -31
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# HTML Wireframe
|
|
2
|
+
|
|
3
|
+
Turn a product question into a low-fidelity HTML artifact that is easy to inspect, change, and discuss. The wireframe should help reviewers decide what belongs on the screen and how the task should work. It should not look like a finished product.
|
|
4
|
+
|
|
5
|
+
## Establish the review question
|
|
6
|
+
|
|
7
|
+
Read the conversation, supplied brief, and nearby project material before choosing a layout. Reuse the project's vocabulary, content model, and known product constraints.
|
|
8
|
+
|
|
9
|
+
Authority runs in this order:
|
|
10
|
+
|
|
11
|
+
1. The user's explicit instructions and accepted decisions.
|
|
12
|
+
2. The product's existing structure and terminology.
|
|
13
|
+
3. The user, task, and content being modeled.
|
|
14
|
+
4. Your own layout judgment.
|
|
15
|
+
|
|
16
|
+
Before coding, identify:
|
|
17
|
+
|
|
18
|
+
- the user and the job they need to complete;
|
|
19
|
+
- the screen or bounded flow under review;
|
|
20
|
+
- the information and actions the artifact must contain;
|
|
21
|
+
- the assumptions that can be made safely;
|
|
22
|
+
- the structural questions the wireframe should help answer.
|
|
23
|
+
|
|
24
|
+
Use real labels and representative content. Low fidelity is not permission to use anonymous boxes or lorem ipsum where wording affects the layout.
|
|
25
|
+
|
|
26
|
+
## Explore structure before style
|
|
27
|
+
|
|
28
|
+
When [`design-artifact`](design-artifact.md) is available, read it for
|
|
29
|
+
subject-specific composition and hierarchy guidance without importing editorial
|
|
30
|
+
polish. This skill's low-fidelity contract remains authoritative.
|
|
31
|
+
|
|
32
|
+
When the layout is still unsettled, create two or three meaningfully different directions. Vary product decisions such as:
|
|
33
|
+
|
|
34
|
+
- navigation model;
|
|
35
|
+
- grouping and order;
|
|
36
|
+
- primary-action placement;
|
|
37
|
+
- content density;
|
|
38
|
+
- overview versus step-by-step flow;
|
|
39
|
+
- desktop-to-mobile reflow.
|
|
40
|
+
|
|
41
|
+
Do not call color changes or minor card rearrangements separate directions. Give each direction a short descriptive name and one sentence about its tradeoff.
|
|
42
|
+
|
|
43
|
+
Keep the directions in one HTML file when practical. Use a small, keyboard-operable selector so reviewers can compare them without opening several files. Preserve the same core content and task across directions. If the user has already chosen a structure, build that direction only.
|
|
44
|
+
|
|
45
|
+
## Keep the artifact intentionally unfinished
|
|
46
|
+
|
|
47
|
+
- Use a restrained grayscale palette, system type, plain borders, and simple blocks.
|
|
48
|
+
- Avoid brand colors, gradients, shadows, illustrations, decorative imagery, and polished component styling.
|
|
49
|
+
- Use limited radius and spacing. Enough order should be present to judge hierarchy, but not enough polish to invite a brand review.
|
|
50
|
+
- Show images or rich media as labeled placeholders unless the asset changes a structural decision.
|
|
51
|
+
- Add annotations only when they expose an assumption, open question, or behavior that cannot be shown directly.
|
|
52
|
+
|
|
53
|
+
The wireframe may still be well composed. Intentional unfinishedness is different from careless spacing, illegible type, or broken responsive behavior.
|
|
54
|
+
|
|
55
|
+
## Add only useful behavior
|
|
56
|
+
|
|
57
|
+
Use basic click-through behavior when it helps test navigation, disclosure, or a short task flow. Keep it immediate and plain.
|
|
58
|
+
|
|
59
|
+
- Make links, tabs, and next or back actions work when they are part of the review.
|
|
60
|
+
- Use native controls and visible keyboard focus.
|
|
61
|
+
- Do not build elaborate animation, persistence, simulated APIs, or production state management.
|
|
62
|
+
- Remove controls that have no review purpose, or label them clearly as out of scope.
|
|
63
|
+
|
|
64
|
+
## Build contract
|
|
65
|
+
|
|
66
|
+
- Deliver one self-contained `.html` file with essential CSS and JavaScript inline.
|
|
67
|
+
- Require no build tooling or external service.
|
|
68
|
+
- Use semantic landmarks, headings, lists, forms, and buttons.
|
|
69
|
+
- Make the layout useful at wide desktop and narrow mobile widths.
|
|
70
|
+
- Keep the page free of accidental horizontal overflow.
|
|
71
|
+
- Respect the source material. Do not invent extra product scope to fill space.
|
|
72
|
+
|
|
73
|
+
## Verify and hand off
|
|
74
|
+
|
|
75
|
+
Open the result at desktop and mobile widths. Check reading order, wrapping, overflow, focus visibility, and every implemented click path. Confirm that the directions remain structurally distinct at both sizes.
|
|
76
|
+
|
|
77
|
+
Return the absolute file path, the names and tradeoffs of the directions, and the visual decisions deliberately deferred to a later mockup or prototype.
|
|
78
|
+
|
|
79
|
+
## Further reading
|
|
80
|
+
|
|
81
|
+
Read Plannotator's [HTML wireframes and prototypes for coding agents](https://docs.plannotator.ai/learn/code-context/html-wireframes-and-prototypes-for-coding-agents) for guidance on what to decide at the wireframe stage.
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# HTML
|
|
2
|
+
|
|
3
|
+
Build one self-contained HTML file that makes the subject clearer, easier to use, or easier to understand. The standard is consistent care, not a consistent look. Do not reproduce a house palette, typography stack, card system, or layout from prior runs.
|
|
4
|
+
|
|
5
|
+
## Route the request first
|
|
6
|
+
|
|
7
|
+
Use the narrowest skill that owns the main review question:
|
|
8
|
+
|
|
9
|
+
- Read and compose [`design-artifact`](design-artifact.md) with the
|
|
10
|
+
chosen workflow when palette, type, composition, theming, or overall visual
|
|
11
|
+
register remain open. It provides creative direction; it does not replace the
|
|
12
|
+
specialist that owns fidelity, structure, or behavior.
|
|
13
|
+
- Read and follow [`html-wireframe`](html-wireframe.md) when structure, information hierarchy, navigation, or task flow is still unsettled. It should remain visibly low fidelity and may compare two or three layout directions.
|
|
14
|
+
- Read and follow [`html-prototype`](html-prototype.md) when the user needs a polished mockup or a working interactive flow. A mockup is the static fidelity mode inside that skill.
|
|
15
|
+
- Read and follow [`html-plan`](html-plan.md) when the artifact is primarily a plan, roadmap, implementation sequence, or rollout document whose source commitments must remain easy to verify.
|
|
16
|
+
- Read and follow [`html-diagram`](html-diagram.md) when relationships, sequence, topology, state, hierarchy, or system behavior are the main content.
|
|
17
|
+
- Continue with `html` for reports, explainers, presentations, landing pages, data stories, tools, and mixed artifacts that do not have a clearer owner.
|
|
18
|
+
|
|
19
|
+
These sibling links are the nesting mechanism when the collection is installed together. If a specialized skill is unavailable, continue here and load the closest reference below. Do not make the user install another skill before completing the request.
|
|
20
|
+
|
|
21
|
+
## Read the room before designing
|
|
22
|
+
|
|
23
|
+
Inspect the user's request and any material they supplied. When working in a repository, look for its design language in `AGENTS.md`, `CLAUDE.md`, design-system documentation, tokens, existing components, and nearby artifacts.
|
|
24
|
+
|
|
25
|
+
Authority runs in this order:
|
|
26
|
+
|
|
27
|
+
1. The user's explicit visual and functional instructions.
|
|
28
|
+
2. The project's established design system and conventions.
|
|
29
|
+
3. The subject matter, audience, and purpose of this artifact.
|
|
30
|
+
4. Your own design judgment.
|
|
31
|
+
|
|
32
|
+
Before coding, settle five things in working notes:
|
|
33
|
+
|
|
34
|
+
- **Audience and job:** who will use this, and what should they understand or do?
|
|
35
|
+
- **Form:** document, presentation, interface, diagram, or data visualization.
|
|
36
|
+
- **Register:** quiet and workmanlike, polished and editorial, or intentionally expressive.
|
|
37
|
+
- **Fidelity:** whether to preserve the user's structure and wording or synthesize more freely.
|
|
38
|
+
- **Interaction:** what benefits from exploration, sequencing, filtering, or motion, if anything.
|
|
39
|
+
|
|
40
|
+
If the project already answers the visual questions, follow it. Otherwise read
|
|
41
|
+
and compose [`design-artifact`](design-artifact.md) when it is
|
|
42
|
+
available. If the collection was installed without that sibling skill, read
|
|
43
|
+
[`creative-direction.md`](creative-direction.md) before
|
|
44
|
+
choosing the palette, type, composition, or motion.
|
|
45
|
+
|
|
46
|
+
## Load only the guidance the artifact needs
|
|
47
|
+
|
|
48
|
+
- For reports, briefs, plans, explainers, and decks, read [`documents-and-presentations.md`](documents-and-presentations.md).
|
|
49
|
+
- For interfaces, calculators, and other tools that remain in this broad skill, read [`interfaces.md`](interfaces.md).
|
|
50
|
+
- For architecture, process, sequence, state, hierarchy, or concept diagrams, read [`diagrams.md`](diagrams.md).
|
|
51
|
+
- For quantitative charts, tables, metrics, or data stories, read [`charts-and-data.md`](charts-and-data.md).
|
|
52
|
+
|
|
53
|
+
Requests can span forms. Read every reference that materially applies, then give the artifact one coherent direction.
|
|
54
|
+
|
|
55
|
+
## Build contract
|
|
56
|
+
|
|
57
|
+
- Produce one `.html` file with its essential CSS and JavaScript inline. It should work when opened directly, without a build step. Do not require a network connection unless the user permits external dependencies.
|
|
58
|
+
- Use real content. Do not fill prominent space with placeholder copy, decorative statistics, or controls that do nothing.
|
|
59
|
+
- Let content determine structure. A sequence should read in order; a comparison should make differences easy to scan; an interface should expose state and actions; a diagram should make relationships legible.
|
|
60
|
+
- Use semantic HTML, responsive layout, accessible contrast, visible keyboard focus, and reduced-motion handling. Make interactive elements work with a keyboard.
|
|
61
|
+
- Keep the page body free of accidental horizontal overflow. Put intentionally broad content in a contained scrolling or pannable region.
|
|
62
|
+
- Define a small set of CSS tokens for the chosen direction and use them consistently. Tokens are an implementation tool, not a predetermined palette.
|
|
63
|
+
- Treat motion as explanation or feedback. If removing an animation loses no meaning or useful feedback, remove it.
|
|
64
|
+
- Follow the user's or project's theme policy. When none exists, give durable utility artifacts considered light and dark themes if that improves their use. A deliberate single-theme concept is valid.
|
|
65
|
+
|
|
66
|
+
## Finish the work
|
|
67
|
+
|
|
68
|
+
Write the file to the requested location, or choose a clear filename in the current workspace. When browser tooling is available, open it and inspect a wide and narrow viewport. Exercise its controls, check the console, and fix clipping, overlap, illegible text, broken states, and accidental overflow.
|
|
69
|
+
|
|
70
|
+
Before delivery, run one originality check: if the subject were swapped for a neighboring topic, would the same visual concept still make just as much sense? If yes, the direction is too generic; revise the composition, type, color, imagery, or interaction so it belongs to this subject.
|
|
71
|
+
|
|
72
|
+
Return the absolute path and a short description of the artifact's visual and interaction choices.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# Interfaces and tools
|
|
2
|
+
|
|
3
|
+
Read this for editors, calculators, control panels, and other broad HTML artifacts people operate rather than read straight through. Use `html-prototype` for a styled mockup or a bounded product flow when that skill is available.
|
|
4
|
+
|
|
5
|
+
Lead with the current state and the next useful action. Organize the interface around the user's task, not the shape of the underlying data model.
|
|
6
|
+
|
|
7
|
+
- Make controls look actionable and label them with the result they produce.
|
|
8
|
+
- Show feedback close to the action: pending, success, empty, validation, and error states should all be designed.
|
|
9
|
+
- Preserve state visibly. Selected filters, active modes, changed values, and unsaved work should never be mysteries.
|
|
10
|
+
- Put summaries before detail when scanning matters, while keeping the path to the underlying evidence obvious.
|
|
11
|
+
- Use status color for status, independently from the artifact's decorative accent.
|
|
12
|
+
- Keep forms keyboard-friendly, labels explicit, targets comfortably sized, and destructive actions difficult to trigger accidentally.
|
|
13
|
+
- Prefer a few strong regions over a uniform grid of interchangeable cards.
|
|
14
|
+
|
|
15
|
+
Implement the important path when behavior is part of the request. A convincing static shell with dead controls is worse than a simpler interface whose important path works end to end.
|
|
16
|
+
|
|
17
|
+
On narrow screens, preserve the primary task. Reflow secondary panels, turn dense toolbars into deliberate controls, and contain wide data rather than shrinking it until it is illegible.
|
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: glab
|
|
3
|
+
description: Expert guidance for using the GitLab CLI (glab) to manage GitLab issues, merge requests, CI/CD pipelines, repositories, and other GitLab operations from the command line. Use this skill when the user needs to interact with GitLab resources or perform GitLab workflows.
|
|
4
|
+
allowed-tools: Bash, Read, Grep, Glob
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# GitLab CLI (glab) Skill
|
|
8
|
+
|
|
9
|
+
Provides guidance for using `glab`, the official GitLab CLI, to perform GitLab operations from the terminal.
|
|
10
|
+
|
|
11
|
+
## When to Use This Skill
|
|
12
|
+
|
|
13
|
+
Invoke when the user needs to:
|
|
14
|
+
- Create, review, or manage merge requests
|
|
15
|
+
- Work with GitLab issues
|
|
16
|
+
- Monitor or trigger CI/CD pipelines
|
|
17
|
+
- Clone or manage repositories
|
|
18
|
+
- Perform any GitLab operation from the command line
|
|
19
|
+
|
|
20
|
+
## Prerequisites
|
|
21
|
+
|
|
22
|
+
Verify glab installation before executing commands:
|
|
23
|
+
```bash
|
|
24
|
+
glab --version
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
If not installed, inform the user and provide platform-specific installation guidance.
|
|
28
|
+
|
|
29
|
+
## Authentication Quick Start
|
|
30
|
+
|
|
31
|
+
Most glab operations require authentication:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# Interactive authentication
|
|
35
|
+
glab auth login
|
|
36
|
+
|
|
37
|
+
# Check authentication status
|
|
38
|
+
glab auth status
|
|
39
|
+
|
|
40
|
+
# For self-hosted GitLab
|
|
41
|
+
glab auth login --hostname gitlab.example.org
|
|
42
|
+
|
|
43
|
+
# Using environment variables
|
|
44
|
+
export GITLAB_TOKEN=your-token
|
|
45
|
+
export GITLAB_HOST=gitlab.example.org # for self-hosted
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Core Workflows
|
|
49
|
+
|
|
50
|
+
### Creating a Merge Request
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
# 1. Ensure branch is pushed
|
|
54
|
+
git push -u origin feature-branch
|
|
55
|
+
|
|
56
|
+
# 2. Create MR
|
|
57
|
+
glab mr create --title "Add feature" --description "Implements X"
|
|
58
|
+
|
|
59
|
+
# With reviewers and labels
|
|
60
|
+
glab mr create --title "Fix bug" --reviewer=alice,bob --label="bug,urgent"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Reviewing Merge Requests
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
# 1. List MRs awaiting your review
|
|
67
|
+
glab mr list --reviewer=@me
|
|
68
|
+
|
|
69
|
+
# 2. Checkout MR locally to test
|
|
70
|
+
glab mr checkout <mr-number>
|
|
71
|
+
|
|
72
|
+
# 3. After testing, approve
|
|
73
|
+
glab mr approve <mr-number>
|
|
74
|
+
|
|
75
|
+
# 4. Add review comments
|
|
76
|
+
glab mr note <mr-number> -m "Please update tests"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Managing Issues
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
# Create issue with labels
|
|
83
|
+
glab issue create --title "Bug in login" --label=bug
|
|
84
|
+
|
|
85
|
+
# Link MR to issue
|
|
86
|
+
glab mr create --title "Fix login" --description "Closes #<issue-number>"
|
|
87
|
+
|
|
88
|
+
# List your assigned issues
|
|
89
|
+
glab issue list --assignee=@me
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Monitoring CI/CD
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
# Watch pipeline in progress
|
|
96
|
+
glab pipeline ci view
|
|
97
|
+
|
|
98
|
+
# Check pipeline status
|
|
99
|
+
glab ci status
|
|
100
|
+
|
|
101
|
+
# View logs if failed
|
|
102
|
+
glab ci trace
|
|
103
|
+
|
|
104
|
+
# Retry failed pipeline
|
|
105
|
+
glab ci retry
|
|
106
|
+
|
|
107
|
+
# Lint CI config before pushing
|
|
108
|
+
glab ci lint
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Common Patterns
|
|
112
|
+
|
|
113
|
+
### Working Outside Repository Context
|
|
114
|
+
|
|
115
|
+
When not in a Git repository, specify the repository:
|
|
116
|
+
```bash
|
|
117
|
+
glab mr list -R owner/repo
|
|
118
|
+
glab issue list -R owner/repo
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Self-Hosted GitLab
|
|
122
|
+
|
|
123
|
+
Set hostname for all commands:
|
|
124
|
+
```bash
|
|
125
|
+
export GITLAB_HOST=gitlab.example.org
|
|
126
|
+
# or per-command
|
|
127
|
+
glab repo clone gitlab.example.org/owner/repo
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Automation and Scripting
|
|
131
|
+
|
|
132
|
+
Use JSON output for parsing:
|
|
133
|
+
```bash
|
|
134
|
+
glab mr list --output=json | jq '.[] | .title'
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Using the API Command
|
|
138
|
+
|
|
139
|
+
The `glab api` command provides direct GitLab API access:
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
# Basic API call
|
|
143
|
+
glab api projects/:id/merge_requests
|
|
144
|
+
|
|
145
|
+
# IMPORTANT: Pagination uses query parameters in URL, NOT flags
|
|
146
|
+
# ❌ WRONG: glab api --per-page=100 projects/:id/jobs
|
|
147
|
+
# ✓ CORRECT: glab api "projects/:id/jobs?per_page=100"
|
|
148
|
+
|
|
149
|
+
# Auto-fetch all pages
|
|
150
|
+
glab api --paginate "projects/:id/pipelines/123/jobs?per_page=100"
|
|
151
|
+
|
|
152
|
+
# POST with data
|
|
153
|
+
glab api --method POST projects/:id/issues --field title="Bug" --field description="Details"
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Best Practices
|
|
157
|
+
|
|
158
|
+
1. **Verify authentication** before executing commands: `glab auth status`
|
|
159
|
+
2. **Use `--help`** to explore command options: `glab <command> --help`
|
|
160
|
+
3. **Link MRs to issues** using "Closes #123" in MR description
|
|
161
|
+
4. **Lint CI config** before pushing: `glab ci lint`
|
|
162
|
+
5. **Check repository context** when commands fail: `git remote -v`
|
|
163
|
+
|
|
164
|
+
## Common Commands Quick Reference
|
|
165
|
+
|
|
166
|
+
**Merge Requests:**
|
|
167
|
+
- `glab mr list --assignee=@me` - Your assigned MRs
|
|
168
|
+
- `glab mr list --reviewer=@me` - MRs for you to review
|
|
169
|
+
- `glab mr create` - Create new MR
|
|
170
|
+
- `glab mr checkout <number>` - Test MR locally
|
|
171
|
+
- `glab mr approve <number>` - Approve MR
|
|
172
|
+
- `glab mr merge <number>` - Merge approved MR
|
|
173
|
+
|
|
174
|
+
**Issues:**
|
|
175
|
+
- `glab issue list` - List all issues
|
|
176
|
+
- `glab issue create` - Create new issue
|
|
177
|
+
- `glab issue close <number>` - Close issue
|
|
178
|
+
|
|
179
|
+
**CI/CD:**
|
|
180
|
+
- `glab pipeline ci view` - Watch pipeline
|
|
181
|
+
- `glab ci status` - Check status
|
|
182
|
+
- `glab ci lint` - Validate .gitlab-ci.yml
|
|
183
|
+
- `glab ci retry` - Retry failed pipeline
|
|
184
|
+
|
|
185
|
+
**Repository:**
|
|
186
|
+
- `glab repo clone owner/repo` - Clone repository
|
|
187
|
+
- `glab repo view` - View repo details
|
|
188
|
+
- `glab repo fork` - Fork repository
|
|
189
|
+
|
|
190
|
+
## Progressive Disclosure
|
|
191
|
+
|
|
192
|
+
For detailed command documentation, refer to:
|
|
193
|
+
- **references/commands-detailed.md** - Comprehensive command reference with all flags and options
|
|
194
|
+
- **references/quick-reference.md** - Condensed command cheat sheet
|
|
195
|
+
- **references/troubleshooting.md** - Detailed error scenarios and solutions
|
|
196
|
+
|
|
197
|
+
Load these references when:
|
|
198
|
+
- User needs specific flag or option details
|
|
199
|
+
- Troubleshooting authentication or connection issues
|
|
200
|
+
- Working with advanced features (API, schedules, variables, etc.)
|
|
201
|
+
|
|
202
|
+
## Common Issues Quick Fixes
|
|
203
|
+
|
|
204
|
+
**"command not found: glab"** - Install glab or verify PATH
|
|
205
|
+
|
|
206
|
+
**"401 Unauthorized"** - Run `glab auth login`
|
|
207
|
+
|
|
208
|
+
**"404 Project Not Found"** - Verify repository name and access permissions
|
|
209
|
+
|
|
210
|
+
**"not a git repository"** - Navigate to repo or use `-R owner/repo` flag
|
|
211
|
+
|
|
212
|
+
**"source branch already has a merge request"** - Use `glab mr list` to find existing MR
|
|
213
|
+
|
|
214
|
+
For detailed troubleshooting, load **references/troubleshooting.md**.
|
|
215
|
+
|
|
216
|
+
## Notes
|
|
217
|
+
|
|
218
|
+
- glab auto-detects repository context from Git remote
|
|
219
|
+
- Most commands have `--web` flag to open in browser
|
|
220
|
+
- Use `--output=json` for scripting and automation
|
|
221
|
+
- Multiple GitLab accounts can be authenticated simultaneously
|
|
222
|
+
- Commands respect Git configuration and current repository context
|