Codebase Onboarding logo

Codebase Onboarding

Community
mturac
codebase-onboarding

不慣れなコードベースを分析し、アーキテクチャマップ、主要なエントリポイント、規約、スターターCODEX.mdを含む構造化オンボーディングガイドを生成します。新しいプロジェクトに参加するか、リポでOpenAI Codexを初めてセットアップする場合に使用します。

Overview

Publishermturac
Repositoryeverything-openai-codex
Skill namecodebase-onboarding
Stars
91
Forks
2
Bundled files
Instructions only
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by mturac on GitHub. Read the source before you install it.

Installation

Install the Codebase Onboarding AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/mturac/everything-openai-codex.git /tmp/everything-openai-codex
mkdir -p .claude/skills
cp -r /tmp/everything-openai-codex/docs/ja-JP/skills/codebase-onboarding .claude/skills/codebase-onboarding
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Codebase Onboarding in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Codebase Onboarding on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Codebase Onboarding is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

コードベースオンボーディング

体系的に不慣れなコードベースを分析し、構造化オンボーディングガイドを作成。新しいプロジェクトに参加するか、既存リポでOpenAI Codexを初めてセットアップする開発者向けに設計。

使用時期

  • OpenAI Codexでプロジェクトを初めて開く
  • 新しいチームまたはリポに参加
  • ユーザーが「このコードベースを理解する手助けをしてください」と求める
  • ユーザーがプロジェクトのCODEX.mdを生成するよう要求
  • ユーザーが「オンボード」または「このリポを説明」と言う

動作方法

フェーズ1:偵察

すべてのファイルを読まずにプロジェクトについての生の信号を集めます。これらのチェックを並行して実行:

1. パッケージマニフェスト検出
   → package.json, go.mod, Cargo.toml, pyproject.toml, pom.xml

2. フレームワークフィンガープリント
   → next.config、nuxt.config、angular.json、vite.config

3. エントリポイント識別
   → main.*、index.*、app.*、server.*

4. ディレクトリ構造スナップショット
   → ディレクトリツリーの最上位2レベル

5. コンフィグとツール検出
   → .eslintrc、.prettierrc、tsconfig.json、Dockerfile

6. テスト構造検出
   → tests/、__tests__/、*.spec.ts、jest.config.*

フェーズ2:アーキテクチャマップ

主要なモジュールとそれらの関係を特定します。

フェーズ3:規約とスタイル

コード規約、命名パターン、プロジェクト固有のパターンを特定。

出力

  • アーキテクチャマップ
  • 主要なエントリポイントと流れ
  • 規約とスタイルガイド
  • スターターCODEX.md

Frequently asked questions

What does the Codebase Onboarding AI skill do?

不慣れなコードベースを分析し、アーキテクチャマップ、主要なエントリポイント、規約、スターターCODEX.mdを含む構造化オンボーディングガイドを生成します。新しいプロジェクトに参加するか、リポでOpenAI Codexを初めてセットアップする場合に使用します。

Why use Codebase Onboarding on TypingMind?

Because you install it once and use it with any model. Codebase Onboarding is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Codebase Onboarding in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/mturac/everything-openai-codex/tree/main/docs/ja-JP/skills/codebase-onboarding. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Codebase Onboarding?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Codebase Onboarding?

As many as you like. As long as a model supports skills, you can use Codebase Onboarding with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Codebase Onboarding AI skill free?

Yes. It is published on GitHub by mturac under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇