Языки:
CLI, который извлекает полезную структуру из исходных файлов: signatures, imports, types, variables, comments, разделы Markdown и формы JSON.
Используйте его, чтобы быстро понять кодовую базу, просмотреть файлы или создать компактный контекст для AI-ассистентов.
В A/B-эксперименте на 25 задачах SWE-bench Lite (SWE-agent, идентичные конфигурации с showsignature и без него) агент решил столько же задач или больше, при этом медианная задача использовала на 62% меньше токенов:
Настройка: SWE-bench Lite (n=25), SWE-agent 1.1.0, deepseek-v4-flash, лимит стоимости $0.25 на инстанс, лимит в 100 вызовов, один сид. Это кейс-стади, а не окончательный бенчмарк.
showsignature выполняется как bash-инструмент, поэтому он должен быть доступен локально или глобально.
#npm|pnpm|yarn
# глобальная установка
npm install -g showsignature
# локальная установка
npm install showsignature/plugin marketplace add FredySandoval/showsignature/plugin install showsignature@showsignature(Чтобы установка сработала, нужно отправить два отдельных промпта)
В настольном приложении нет команды /plugin. Вместо этого установите его через UI: Customize, + рядом с personal plugins, Create plugin and add marketplace, Add from repository, затем введите URL репозитория.
codex plugin marketplace add FredySandoval/showsignature
codexОткройте /plugins, выберите marketplace showsignature и установите showsignature. Затем откройте /hooks, проверьте и доверьте его lifecycle hook, и начните новый поток.
Эта же установка также подходит для настольного приложения Codex: перезапустите приложение после установки, и оно подхватит plugin.
# Все agents
npx skills add https://github.com/FredySandoval/showsignature --skill showsignature# вариант 1
pi install npm:showsignature
# вариант 2
pi install git:github.com/FredySandoval/showsignature
# вариант 3
pi install https://github.com/FredySandoval/showsignaturegit clone https://github.com/FredySandoval/showsignature.git
cd showsignature
pnpm install
pnpm build
pnpm link --globalБольшие файлы шумные. showsignature показывает форму проекта до того, как вы начнете читать реализацию:
- Какие функции/классы существуют?
- Что каждый файл import/export?
- Какие types и interfaces определяют данные?
- Какие headings/tables/code blocks есть в Markdown?
- Какую форму имеет JSON-файл?
showsignature map [OPTION]... [PATH]...
showsignature read [OPTION]... <FILE>Две команды:
map— структурный обзор: сигнатуры и другие извлечённые записи. Проверяет операнды [PATH] — файлы или пути к каталогам — по умолчанию используя текущий каталог.read— оконное дословное чтение ровно одного файла, обрамлённое «скелетом» сигнатур для ориентации.
Запуск showsignature без команды печатает справку и завершается с кодом 1.
Опции showsignature map:
| OPTION | Описание |
|---|---|
--lang <lang> |
Принудительно задает язык; требуется при чтении stdin через -. |
--only <items> |
Выбирает extractors. |
--include-tests |
Включает тестовые файлы при сканировании папок. |
--max-depth <n> |
Ограничивает глубину сканирования (для каталогов по умолчанию 2). |
--skip <n> |
Пропускает первые N извлечённых записей (по умолчанию: 0). |
--take <n> |
Максимум показанных извлечённых записей. |
--all |
Отключает все ограничения вывода (лимит записей и порог 2000 строк / 50 КБ). |
--no-redact |
Отключает встроенное скрытие секретов. |
--no-line-number |
Скрывает префиксы с номерами строк. |
Опции showsignature read:
| OPTION | Описание |
|---|---|
--offset <n> |
Первая показанная строка, нумерация с 1 (по умолчанию: 1). |
--limit <n> |
Максимум строк в окне. |
--all |
Отключает порог окна 2000 строк / 50 КБ. |
--lang <lang> |
Язык для скелета; включает скелеты при чтении stdin (-). |
--outline <items> |
Extractors для скелета (по умолчанию: signatures). |
--no-line-number |
Скрывает номера строк в скелете (в содержимом их никогда нет). |
--no-redact |
Отключает скрытие секретов, чтобы получить дословные байты. |
Note: map → ENTRIES (--skip/--take); read → LINES (--offset/--limit).
Вывод по умолчанию ограничен 2000 строками / 50 КБ; когда срабатывает ограничение или
глубина сканирования по умолчанию, вывод заканчивается единственным трейлером note:
(дублируется в stderr), в котором указаны точные флаги или следующая команда для продолжения.
Файлы кода:
| Mode | Показывает |
|---|---|
signatures |
Функции, классы, методы, конструкторы. |
imports |
Операторы/объявления import. |
exports |
JS/TS exports, экспортированные объявления Go и Python public exports. |
interfaces |
TypeScript/Go interfaces. |
types |
Псевдонимы/объявления типов. |
variables |
Переменные/константы. |
comments |
Комментарии кода. |
Файлы Markdown и JSON:
| Mode | Показывает |
|---|---|
md:headings |
Заголовки. |
md:tables |
Таблицы. |
md:codeblocks |
Огражденные блоки кода. |
json:shape |
Форму значения JSON. |
| Language | Extensions |
|---|---|
| TypeScript | .ts, .mts, .cts |
| JavaScript | .js, .mjs, .cjs |
| TSX/JSX | .tsx, .jsx |
| Svelte | .svelte |
| Go | .go |
| Python | .py |
| Rust | .rs |
| Lua | .lua |
| Markdown | .md |
| JSON | .json |
showsignature map [OPTION]... [PATH]... / showsignature read [OPTION]... <FILE>
showsignature map ./src # Проверить папку
showsignature map src/01-main.ts # Проверить один файл
showsignature map src/main.ts README.md tests/fixtures # [PATH] может быть одним или несколькими файлами/каталогами
showsignature map --only imports,exports # Показать только exports
showsignature map --only signatures,imports,exports ./src # Показать структуру кода и imports
showsignature map --only interfaces,types ./folder # Показать формы данных
showsignature map --only variables,comments src/main.ts # Показать variables
showsignature map --only md:headings # Извлечь Markdown headings
showsignature map --only md:tables,md:codeblocks # Извлечь Markdown tables
showsignature map --only json:shape config.json # Извлечь JSON shape
# полезно при миграциях с одного языка на другой
showsignature map --lang py # Обрабатывать только файлы Python
showsignature map --lang go --only imports,exports # Показать Go imports и exported declarations
showsignature map --lang py --only types,comments # Показать Python imports и public exports
showsignature map --max-depth 4 # Ограничить глубину рекурсивного сканирования
showsignature map --skip 40 --take 40 ./src # Постраничный просмотр большого списка записей
showsignature map --all ./src # Отключить ограничения выводаПрочитать один файл дословно, в обрамлении скелета сигнатур:
showsignature read src/01-main.ts # Первые строки файла (до порога)
showsignature read --offset 200 --limit 100 src/01-main.ts # Строки 200-299, скелеты вокруг окна
showsignature read --no-redact src/config.ts # Дословные байты, без скрытия секретов
cat snippet.py | showsignature read - --lang py # Stdin; --lang включает скелетСтроки скелета содержат реальные номера строк, поэтому можно перейти в любое место через
showsignature read --offset <строка> <файл>. Содержимое между тегами <content> — сырое,
без префиксов номеров строк, и его безопасно копировать в инструменты правки по точному совпадению.
Комбинируйте режимы через запятые:
showsignature map src --only signatures,imports,commentsshowsignature печатает компактный текстовый вывод. Используйте перенаправление shell, чтобы сохранить вывод в файл:
showsignature map src --only signatures > structure.txtshowsignature по умолчанию пишет в stdout, поэтому хорошо работает с такими инструментами, как rg, grep, fzf, less, head, tee, и перенаправлениями shell.
showsignature map src --only imports | rg "node" # Найти совпадающие imports
showsignature map src --only signatures | rg "async" # Найти async функции или методы
showsignature map src --only comments,signatures | rg -C 2 "ExtractKind" # Искать comments/signatures с ближайшим контекстом
showsignature map src --only signatures,imports | bat -l js # Просматривать большой вывод постраничноpnpm install
pnpm build
pnpm test
pnpm typecheck
pnpm formatISC. См. LICENSE.