logomarks 0.0.0-stage → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to `logomarks` are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] — 2026-11-06
+
+The first public release (0.2.0 was never published).
+
+### Added
+
+- **Find and get.** `find` searches the bundled Logomarks set (CC0) as logomarks.ai does: every word must match, with synonyms, plurals and UK and US trade names, and `--style`, `--tag`, `--industry` and `--letter` filters. `get` writes a live mark's SVG in a colour, or a PNG at a size.
+- **Check.** `check` runs every house rule (fit to the 512 grid, markup, specks, slivers, pin-holes, clipping, thin parts, narrow and uneven gaps), each finding with an id and a box; `--fix` refits. `similar` scores a mark against every live mark (`--letters`, `--against`, `--each`, `--all`). `specks` is the set's speck review. `sheet` draws review cards, or a plain grid with `--plain`.
+- **Edit.** `parts` lists a mark's parts by index; `edit` runs a JSON list of ops by part (delete, move, rotate, scale, flip, round, offset, mirror, radial, union, subtract, colour, two-tone); `glitch` makes glitch editions (`shear`, `slice`, `bands`, `stepped`, `lane`; the same seed gives the same bytes); `combine` makes two marks one (union, subtract, intersect, exclude, place). Every result is fitted to the grid and checked, and a failing result exits 1.
+- **Build.** `kit` writes a brand kit from `@logomarks/brand-kit`: the mark's files, favicons and app icons, lockups, an OKLCH palette with WCAG pairings, a Tailwind theme and tokens, a brand sheet, a guidelines deck (slides and a PDF), a seal lockup, `brand.json` and a social pack (`--styles` adds an opt-in `gradient` style). `social` writes the social pack alone. `mockup` puts the brand on one of 20 objects; `cover` draws an Open Graph image, header or post.
+- **MCP server.** `logomarks mcp` runs every command as a tool on stdio: `find_marks`, `get_mark`, `check_mark`, `similar_marks`, `review_sheet`, `list_parts`, `edit_mark`, `glitch_mark`, `combine_marks`, `build_brand_kit`, `build_social_pack`, `render_mockup` and `render_cover`. Tools that make images return a preview to look at; given `out`, they write the file and return its path rather than the SVG text. Each tool carries read-only and destructive hints.
+- **Typefaces.** Ten bundled faces for a brand's name (`--font`), all SIL OFL: Inter, Space Grotesk, Instrument Sans, Bricolage Grotesque, Instrument Serif, IBM Plex Mono, and for restaurants Fraunces, Cagliostro, Limelight and Shrikhand. The faces with a Reserved Font Name (Cagliostro, Limelight, IBM Plex Mono) are the unmodified upstream files, pinned by sha256.
+- **Help.** `logomarks <command> --help` (or `logomarks help <command>`) for every command, with its options, defaults and examples; `--version`.
+- **Errors.** Exit codes 0 ok, 1 a check failed or the command failed, 2 usage. Errors are one line naming the command; `LOGOMARKS_DEBUG=1` adds the stack.
+- **Library.** Every function behind the commands is exported (`logomarks`), and the MCP server too (`logomarks/mcp`), with TypeScript declarations.
+- Docs in `docs/`: commands, editing, MCP tools and the API.
+
+Built on `@logomarks/core`, `@logomarks/editor`, `@logomarks/brand-kit`, `@logomarks/mockups`, `@arraypress/covers` and `@arraypress/search`. Pure JavaScript: PNGs are drawn by resvg in WebAssembly, with no native binaries.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ArrayPress Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,57 @@
-# Temporary Holding Version
+# logomarks
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Find, check, edit and build on free geometric logomarks from the command line or an AI agent. The [Logomarks](https://logomarks.ai) set is bundled (CC0, searched offline); the CLI checks marks against the set's house rules, edits and glitches them, and builds a brand kit, social pack, mockups and covers. It also runs as an MCP server. Pure JavaScript (resvg in WebAssembly), no native binaries, Node 20 or later.
+
+```bash
+npx logomarks find coffee
+```
+
+## Commands
+
+```bash
+npx logomarks find calm hexagon                       # search the set: slugs, styles, descriptions
+npx logomarks get hex-gem --color '#ff5c3a' -o logo.svg
+npx logomarks check mark.svg                          # every house rule; exit 1 on errors
+npx logomarks similar mark.svg                        # the nearest live marks, with scores
+npx logomarks edit quad-cove --ops '[{"op":"round","radius":18}]' -o mine.svg
+npx logomarks glitch quad-cove --preset shear --seed 3 -o glitched.svg
+npx logomarks kit hex-gem --name "Hexa Labs" --color '#ff5c3a' -o hexa/
+npx logomarks mockup hex-gem --name "Hexa Labs" --object card -o card.png
+```
+
+Also `specks`, `sheet`, `parts`, `combine`, `social`, `cover` and `mcp`. Run `logomarks --help` for the list and `logomarks <command> --help` for a command's options. A mark is a live slug or name, or the path to your own `.svg`. Every edit comes back fitted to the grid and checked. Every command takes `--json`. Exit codes: 0 ok, 1 a check failed or the command failed, 2 usage.
+
+## AI agents
+
+As a Claude Code plugin, with the two Logomarks skills (picking a mark, designing new ones) and this MCP server:
+
+```
+/plugin marketplace add logomarks/skills
+/plugin install logomarks@logomarks
+```
+
+The skills alone, for any agent that reads skills (Claude Code, Cursor, Codex and more):
+
+```bash
+npx skills add logomarks/skills
+```
+
+The MCP server alone:
+
+```bash
+claude mcp add logomarks -- npx -y logomarks mcp
+codex mcp add logomarks -- npx -y logomarks mcp
+```
+
+## Docs
+
+- [Commands](docs/commands.md): every command, its options and exit codes, and the checks.
+- [Editing](docs/editing.md): glitch presets, edit ops and combining.
+- [MCP tools](docs/mcp.md): each tool, its arguments and what it returns.
+- [API](docs/api.md): the functions behind them, for use as a library.
+
+Built on [`@logomarks/core`](https://github.com/Logomarks/core), [`@logomarks/editor`](https://github.com/Logomarks/editor), [`@logomarks/brand-kit`](https://github.com/Logomarks/brand-kit), [`@logomarks/mockups`](https://github.com/Logomarks/mockups) and [`@arraypress/covers`](https://github.com/arraypress/covers).
+
+## Licence
+
+The CLI is MIT © ArrayPress Limited. The marks are CC0 (public domain). The bundled typefaces are SIL Open Font License 1.1 (`data/fonts/OFL.txt`).

package/bin/logomarks.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { main } from '../src/cli/index.js';
+
+process.exitCode = await main(process.argv.slice(2));

package/data/fonts/OFL.txt

@@ -0,0 +1,103 @@
+Copyright 2016 The Inter Project Authors (https://github.com/rsms/inter) Inter-Italic[opsz,wght].ttf: Copyright 2016 The Inter Project Authors (https://github.com/rsms/inter)
+Copyright 2020 The Space Grotesk Project Authors (https://github.com/floriankarsten/space-grotesk)
+Copyright 2022 The Instrument Sans Project Authors (https://github.com/Instrument/instrument-sans) InstrumentSans-Italic[wdth,wght].ttf: Copyright 2022 The Instrument Sans Project Authors (https://github.com/Instrument/instrument-sans)
+Copyright 2022 The Bricolage Grotesque Project Authors (https://github.com/ateliertriay/bricolage)
+Copyright 2022 The Instrument Serif Project Authors (https://github.com/Instrument/instrument-serif) InstrumentSerif-Italic.ttf: Copyright 2022 The Instrument Serif Project Authors (https://github.com/Instrument/instrument-serif)
+Copyright 2020 The Fraunces Project Authors (github.com/undercasetype/Fraunces) Fraunces-Italic[SOFT,WONK,opsz,wght].ttf: Copyright 2020 The Fraunces Project Authors (github.com/undercasetype/Fraunces)
+Copyright (c) 2011, Matthew Desmond (http://www.madtype.com | mattdesmond@gmail.com),with Reserved Font Name Cagliostro.
+Copyright (c) 2011 by Sorkin Type Co (www.sorkintype.com),
+with Reserved Font Name "Limelight".
+Copyright (c) 2015 Jonny Pinhorn (jonpinhorn.typedesign@gmail.com)
+Copyright © 2017 IBM Corp. with Reserved Font Name "Plex"
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/docs/api.md

@@ -0,0 +1,31 @@
+# API
+
+```js
+import { check, glitchMark, kit } from 'logomarks';
+import { createServer, TOOLS } from 'logomarks/mcp';
+```
+
+| Export | |
+|---|---|
+| `check(svg, { name, ignore, strict })` | `{ ok, errors, warnings, notes, size, findings }`. |
+| `fix(svg)` | The mark refitted, or `null` when there's nothing safe to fix. |
+| `similar(svg, { top, letters, exclude })` | `[{ slug, name, score, verdict }]`, closest first. |
+| `sheet([{ name, svg }])` | `{ png, svg, marks }`. |
+| `findMarks(query, { style, tags, industry, letter, limit })`, `facets()` | `{ total, marks }`; the filters' values. |
+| `fitMark(svg)`, `loadIndex()`, `FINDINGS`, `rules` | The fitter, the live set, every finding id, the house rules. |
+| `loadMark(ref)`, `paint(svg, color)`, `markPng(svg, { size, color })` | A mark by slug, name or file; as a file in a colour; as a PNG. |
+| `glitchMark(svg, { preset, angle, place, slide, gap, cuts, seed })` | `{ svg, checks, glitch }`. |
+| `editMark(svg, ops)`, `markParts(svg)` | `{ svg, checks, parts }`; the parts by index. |
+| `combineMarks(a, b, { op, transform })` | `{ svg, checks }`. |
+| `markPreview(svg)`, `partsPreview(svg, parts)` | 512 px PNGs: the result; the parts numbered. |
+| `PRESETS`, `OPS`, `COMBINE_OPS` | The glitch presets, the edit ops, the combine ops. |
+| `kit({ mark, name, color, font, tagline, url, handle, styles, platforms, animated, social })` | brand-kit's `{ files, brand }`: every file by path, in memory. |
+| `social({ mark, name, …, platforms, styles, animated })` | brand-kit's `{ files, brand }`. |
+| `brandInput(o)`, `brandFont(id)` | The brand as brand-kit takes it; a bundled face as bytes. |
+| `mockup({ mark, object, … })`, `cover({ mark, recipe, … })` | `{ png, svg, width, height }`. |
+| `parseColor`, `FONTS`, `OBJECTS`, `RECIPES` | The parts they're built from. |
+| `createServer({ cwd })`, `TOOLS` from `logomarks/mcp` | The MCP server (not connected) and its tools. |
+
+The palette, lockups and artwork are [`@logomarks/brand-kit`](https://github.com/Logomarks/brand-kit)'s (`palette`, `lockup`, `artwork`), and the edits are [`@logomarks/editor`](https://github.com/Logomarks/editor)'s.
+
+The live set is bundled (`data/index.bin`: each mark's SVG, tags, style, mood, description and industries, and its signatures; rebuilt with `npm run index`). The marks are CC0. The typefaces (IBM Plex Mono for labels; Inter, Space Grotesk, Instrument Sans, Bricolage Grotesque, Instrument Serif, and for restaurants Fraunces, Cagliostro, Limelight and Shrikhand, for names) are SIL OFL, in `data/fonts/` (`OFL.txt`; `scripts/fonts.js` writes them): latin subsets, except the faces with a Reserved Font Name (Cagliostro, Limelight, IBM Plex Mono), bundled whole and pinned by sha256.