Auric Artisan Plugins User Guide
Overview
Auric Artisan plugins bring the same color accessibility engine into the places where color work happens: design files, code editors, launchers and team chat. Use this guide to choose the right plugin, install it, run contrast checks, generate palettes, preview color-vision states and keep social publishing under control.
1. Overview
+The plugins suite is built for practical color decisions inside daily tools. Figma, Penpot and Sketch work on selected design layers. VS Code works on colors, markup and code in source files and across the workspace. Alfred and Raycast provide fast system-wide contrast checks. The bot worker brings the same contrast logic to Slack and Discord and can publish Color of the Day posts to social targets.
| Plugin | Best for | Main result |
|---|---|---|
| Figma | Design-file audits, fixes, palettes and vision preview | Tabbed panel with Audit, Palette, Fix and Vision panes |
| Penpot | Open design-file accessibility checks | Same panel model adapted to Penpot shapes |
| Sketch | Native macOS design workflows | Menu commands for audit, fix, palette and vision preview |
| VS Code | Color, accessibility and code-health checks while you write | Hover readouts, a color picker, inline diagnostics, a workspace score and the Studio |
| Alfred and Raycast | Fast one-off checks from the keyboard | Copyable ratio, APCA Lc, hex and summary values |
| Slack and Discord | Team color decisions in chat | Verified slash-command replies with WCAG and APCA |
2. Choose a plugin
+- Use a design plugin when the question is "Which layers in this file fail contrast?"
- Use VS Code when the question is "Does this code contain failing color pairs, WCAG problems or leftover secrets?"
- Use Alfred or Raycast when the question is "What is the contrast between these two colors?"
- Use Slack or Discord when a team needs a shared, timestamped contrast answer in a channel.
- Use the Color of the Day bot when publishing scheduled brand content from the same public color data used by the site.
The plugins are intentionally small and focused. They do not replace the full Auric Artisan web tools; they bring the highest-frequency color checks into the editor, design canvas or chat context where you already are.
3. Figma plugin
+The Figma plugin is a local design-panel workflow with four menu commands: Audit selection, Generate accessible palette, Fix failing pair and Vision sim preview. The panel opens at 360 by 560 pixels and shows the current selection count.
| Pane | How to use it |
|---|---|
| Audit | Select a frame or layers, run the audit, review failing text and UI pairs, then outline or select failing nodes. |
| Palette | Choose a seed, background, harmony and target ratio. Generate swatches and apply them to selected nodes. |
| Fix | After an audit, pick a target ratio and nudge one or all failing fills until they meet the target where possible. |
| Vision | Preview selected fills under deuteranopia, protanopia, tritanopia or achromatopsia. |
If nothing is selected, the audit scope falls back to the current page. The plugin estimates effective background by walking parent fills and page backgrounds, then reports WCAG ratio and APCA Lc for failing pairs.
4. Penpot plugin
+
The Penpot plugin mirrors the Figma workflow, with Penpot-specific shape APIs and a status pill
inside the iframe UI. It asks for content:write so it can apply palettes, draw
outlines and auto-fix fills, and user:read for the plugin host context.
- Run Audit to scan selected shapes or the current page.
- Use Outline failing to draw red dashed rectangles around failing shapes.
- Use Clear outlines before handing off or exporting a file.
- Generate palettes from a typed seed, selected fill or default blue seed.
- Use Fix all failing after reviewing the list so changed colors are intentional.
Penpot text contrast is the dominant v1 audit path. Fill-vs-stroke checks are not the main Penpot focus in this version, so use visual review for non-text UI details after running the text audit.
5. Sketch plugin
+
The Sketch plugin installs as Auric Artisan.sketchplugin and exposes an Auric
Artisan menu with four commands. It supports Sketch compatible version 94 and newer.
| Command | Shortcut | Result |
|---|---|---|
| Audit selection | ctrl shift a |
Scans selected layers or the document, lists failing text layers and can select them on canvas. |
| Auto-fix failing pairs | Menu command | Nudges failing text colors along Lab lightness until AA passes where possible. |
| Generate accessible palette | ctrl shift p |
Prompts for seed, background, harmony and target ratio, then drops swatches on the page. |
| Vision simulation preview | Menu command | Duplicates the selected layers to the right and transforms colors for the chosen CVD mode. |
The Sketch plugin works directly with layer colors. Always review auto-fixed colors before final export because the tool is optimizing contrast, not preserving brand color intent.
6. VS Code extension
+Auric Artisan — Color, Accessibility & Code Health (version 0.13.2) checks colors, accessibility and code health while you write, and grades the whole workspace. It runs locally, with no account and no network access, and needs VS Code 1.74 or newer. A packaged build installs with Extensions: Install from VSIX.
It starts when you open a CSS-family, JavaScript, TypeScript, React, HTML, Vue, Svelte, Astro, PHP, JSON, JSONC, Markdown or XML file, open its Accessibility Issues view, or run one of its commands. Color hovers, swatches and the picker also work in many other languages, such as Python, Go, Rust, YAML and TOML.
- Hover a color: RGB, HSL, OKLCH and Display-P3 values, the nearest CSS name, contrast against white and black, and a color-vision preview.
- Pick a color: the Auric picker (spectrum, hue and alpha, eyedropper, brand and
recent swatches, WCAG and APCA readouts) opens from a swatch's hover, the right-click menu or
Ctrl+Alt+C(Cmd+Alt+Con macOS) and writes the color back in the format you choose. SetauricArtisan.colorPicker.modetodecoratorsto use VS Code's own picker instead; Restore native color picker hands the picker back to VS Code in one step. - Inspect: hover an element or a CSS rule, or press
Ctrl+Alt+A(Cmd+Alt+A), to see its accessible name and role, the colors that apply, the contrast verdict with APCA and a color-vision check, a before and after preview, and the WCAG issues found there. - Contrast diagnostics: color and background pairs that can be read from the
source, in stylesheets, style blocks, inline styles, CSS-in-JS and framework style bindings,
including
var()tokens, are checked againstauricArtisan.contrast.threshold. A failing pair is underlined with a Fix contrast quick fix, and Fix All Contrast Issues in File shows every change before applying them as one undoable edit. - WCAG checks: 62 markup and CSS rules across 28 WCAG success criteria, under the
profile in
auricArtisan.a11y.profile(2.0, 2.1, 2.2 or 3.0-draft). Each finding names its success criterion and level and suggests a fix; only fixes that are safe to make automatically are applied for you. - Code Health: in any language, it flags likely hardcoded secrets, security
footguns such as disabled TLS checks, weak crypto and injection, risky APIs, debug leftovers,
merge-conflict markers, TODO and FIXME markers, and oversized files. Each check has its own
auricArtisan.codeHealth.*switch. - Suppress a finding: add an
auric-disable-line,auric-disable-next-lineorauric-disable-filecomment; the quick fix inserts the right one for the language. - Scan the workspace: Scan Project for Accessibility gives the workspace a 0 to
100 score and a letter grade, and lists every finding in the Accessibility Issues view, where you
can search and group them by type, file or severity. The Overview panel in the activity bar
shows the score, and
auricArtisan.scan.liveupdates it as you type. - The Studio: Open Color & Accessibility Studio has eight tabs: Scan, Contrast, Preview, Brand, Palette, Shades, Vision and Settings.
- Reports: Generate Project Health Report opens one report for color,
accessibility and code health. Write Health Record writes
health.json, a SARIF 2.1.0 file and a trend history to the workspace.auric-artisanfolder, and Generate Agent-Ready Remediation Plan writes a Markdown and JSON fix plan there. - In CI: the same engine runs without the editor as
auric-artisan scan, with--json,--sarif,--baseline,--fail-on,--max-newand--min-score. It exits with 0 on a pass, 1 on a policy violation and 2 on an error.
| Setting | Default |
|---|---|
auricArtisan.hover.enabled |
true |
auricArtisan.inspect.enabled |
true |
auricArtisan.colorPicker.mode |
auric |
auricArtisan.contrast.enabled |
true |
auricArtisan.contrast.standard |
wcag2 |
auricArtisan.contrast.threshold |
4.5 |
auricArtisan.contrast.severity |
warning |
auricArtisan.a11y.profile |
2.2 |
auricArtisan.codeHealth.enabled |
true |
auricArtisan.scan.live |
true |
auricArtisan.scan.autoScan |
false |
auricArtisan.appearance.accent |
gold |
The extension has 23 commands and 46 settings; the
Plugins Developer
Reference lists them all. A 1.0.0 build, not yet released, splits it into Auric Color, Auric
Accessibility and Auric Code Health, with Auric Artisan becoming a pack that installs all three.
Its command and setting names move to new prefixes, such as auricA11y.scanProject
and auricColor.contrast.threshold, so custom keybindings and settings will need
updating.
7. Alfred workflow
+
The Alfred workflow is a fast local contrast checker for macOS. Install the
Auric Artisan.alfredworkflow bundle, then trigger Alfred and type:
aa contrast #222 #fff
aa contrast red goldenrod
aa contrast "rgb(30 41 59)" "#fff"
- The first result copies the WCAG ratio.
- The APCA row copies the numeric Lc value.
- Foreground and background rows copy normalized HEX values.
- The summary row copies foreground, background, WCAG and APCA together.
- Node.js 18 or newer must be available on your PATH.
8. Raycast extension
+
The Raycast extension exposes a single Check Contrast command. Provide foreground
and background arguments and Raycast opens a detail view with live preview, metadata and copy
actions.
- Copy Ratio copies a value such as
4.72:1. - Copy Summary copies normalized colors plus WCAG and APCA verdicts.
- Copy Foreground HEX uses
cmd+f. - Copy Background HEX uses
cmd+b. - The detail view shows nearest CSS names, RGB, HSL, WCAG body, WCAG large, AAA and APCA verdicts.
Like Alfred, Raycast runs locally. It does not require an API key or an Auric Artisan account for contrast checks.
9. Slack and Discord bots
+
The bot worker gives teams shared contrast answers in chat. Slack sends a signed slash-command
request to POST /slack. Discord sends signed interactions to
POST /discord. Both call the same contrast handler.
| Platform | Setup | Response |
|---|---|---|
| Slack | Configure the slash command URL and SLACK_SIGNING_SECRET. |
Block Kit response with ratio, APCA, verdicts, nearest names and suggested AA foreground when needed. |
| Discord | Configure interactions URL, DISCORD_PUBLIC_KEY and register
aa-contrast. |
Embed response with WCAG/APCA fields and a color-tinted accent. |
Use the query format that humans already use: #222 #fff,
red goldenrod or rgb(30 41 59) white.
11. Supported color inputs
+Launcher, editor and bot parsers share the same practical input vocabulary. The exact platform UI differs, but the expected color syntax is consistent.
| Format | Examples |
|---|---|
| HEX | #fff, #ffffff, #ffffffff |
| RGB | rgb(255, 0, 0), rgba(255 0 0 / 50%) |
| HSL | hsl(0, 100%, 50%), hsla(0 100% 50% / .5) |
| CSS names | red, goldenrod, rebeccapurple |
Design plugins mostly read colors from the host document. Palette generators accept seed and background HEX values in their UI prompts or inputs.
12. Reading results
+WCAG ratiocompares relative luminance. Body text typically targets 4.5:1, large text and UI targets often use 3.0:1, and AAA body targets 7.0:1.APCA Lcis polarity-aware. Higher absolute values indicate stronger perceived contrast under the simplified plugin implementation.Nearest CSS nameis a convenience label, not a design-token recommendation.Nudgedcolors were moved to improve contrast. They should be reviewed against brand requirements.Vision simulationpreviews confusion risk; it does not replace numeric contrast checks.
13. Privacy and permissions
+The design, editor and launcher plugins run locally in their host applications. They inspect the selected document, active source file or typed colors and do not need remote Auric Artisan API calls for contrast results.
- Figma declares no network access domains.
- Penpot needs write permission for outlines, palette application and color fixes.
- VS Code scans text documents in supported languages, caps color-provider work on large
files, and writes its scan cache and reports only to the workspace
.auric-artisanfolder. - Slack and Discord requests are verified before processing.
- Social posting uses target credentials and should stay in dry-run mode until reviewed.
14. Troubleshooting
+| Problem | Check |
|---|---|
| Alfred returns no results | Confirm Node.js 18 or newer is on PATH and the query has two colors. |
| Raycast cannot parse input | Use separate foreground and background arguments and avoid unsupported color functions. |
| Design audit finds nothing | Select the intended frame or verify text layers use solid visible fills. |
| Auto-fix changes too much | Undo the change and use a lower target such as 3.0 for large text or UI controls. |
| VS Code diagnostics do not appear | Confirm the check is on (auricArtisan.contrast.enabled,
a11y.enabled or codeHealth.enabled), the colors are written in the
source rather than computed at runtime, and no suppression comment covers the line. Then run
Refresh Contrast Diagnostics. |
| Slack or Discord returns unauthorized | Check signing secrets, public keys, timestamps and endpoint URLs. |
| Social bot does not publish | Confirm target credentials, SOCIAL_POST_ENABLED=1 and authorization
headers. |
15. Recommended team workflow
+- Use Figma, Penpot or Sketch before design handoff to audit selected components and frames.
- Generate accessible palette candidates from the design plugin when a palette needs local correction.
- Preview color-vision states for product-critical color coding, charts, badges and alerts.
- Use VS Code during implementation to catch failing color pairs, WCAG problems and code-health findings, and run the auric-artisan scan CLI on pull requests.
- Use Alfred, Raycast, Slack or Discord for quick pair checks during reviews.
- Keep social posting in preview or dry-run mode until brand, copy and targets are approved.
For implementation and release details, see the Plugins Developer Reference.
10. Color Of The Day Social Bot
+The social bot reads the public Color of the Day source, derives the same daily color as the website widget and posts to configured targets. The Cloudflare cron is set to
30 3 * * *, which is 09:00 in Asia/Kolkata.GET /social/color-of-day/previewreturns the exact post text without publishing.POST /social/color-of-daypublishes when authorized and enabled.Authorization: Bearer <SOCIAL_POST_SECRET>orx-auric-social-secret.?dry_run=1to preview through the publish route, or?force=1to post again on a day that already has a post.GET /social/x/verifychecks the configured X account, andPOST /social/x/selftestpublishes a throwaway X post and deletes it (?keep=1keeps it). Both need the same secret.SOCIAL_POST_DRY_RUN=1until target credentials and copy are verified.Posting is off in the committed
plugins/bots/wrangler.toml:SOCIAL_POST_ENABLEDis0andSOCIAL_POST_DRY_RUNis1.Set
SOCIAL_POST_ENABLED=1only after previewing the post and confirming that at least one target is configured.