Files
Bundle OKF 0.1 · 8 conceitos · EduardFerrer/repo-template
Open source Repository Open in the app JSON README (API)
About
# Files
- [Integrations and editor wiring](integrations.md) - Covers the repository's GitHub Actions refresh workflow, optional MCP configuration example, and VS Code assets that ship with the scaffold.
- [Repo Template Scaffold](quickstart.md) - Entry point for the repository wiki. Explains the scaffold CLI, generated document set, changelog updater, editor assets, and where future agents should start.
- [Source map](source-map.md) - Compact map of the repository files that matter most for understanding the scaffold, generated assets, policies, and automation.
- [Testing and verification](testing.md) - Summarizes the current verification approach for the scaffold, including build checks, manual output inspection, and the missing automated test coverage.
# Directories
- [architecture](architecture/)
- [domain](domain/)
- [operations](operations/)
- [workflows](workflows/)
Details
- Kind
- OKF bundles
- Topic
- Developer tools
- Publisher
- eduardferrer
- Origin
- okf_github
- Category
- dados
- Version
- 0.1
- Last push
- 2026-07-26T10:42:54Z
- Repository state
- ativo
- Language
- TypeScript
- Added
- 2026-09-08 16:04:09
- Updated
- 2026-09-08 16:04:09
- Origin id
EduardFerrer/repo-template:openwiki/index.md
README
# Repo Template Scaffold Create a new project skeleton with standard documents and VS Code snippets from any directory. ## What this repo does - Creates a predictable set of project files. - Fills the files with placeholders and short instructions. - Adds VS Code snippets so the same content can be inserted with Tab stops. ## Install ```bash npm install npm run build npm link ``` After linking, the command is available from any directory as `repo-template`. ## Usage ```bash repo-template init my-new-project ``` You can also omit the `init` subcommand: ```bash repo-template my-new-project ``` To create the scaffold in the current directory, omit the directory too: ```bash repo-template ``` Existing files are preserved by default. Add `--force` to overwrite them. ### Options - `--name <name>`: project name used in generated documents. - `--description <text>`: short project description. - `--owner <name>`: person or team responsible for the project. - `--force`: overwrite existing files. ## Generated files - `AGENTS.md` - `README.md` - `CONTRIBUTING.md` - `CHANGELOG.md` - `scripts/update-changelog.js` - `ROADMAP.md` - `SECURITY.md` - `CODE_OF_CONDUCT.md` - `.agents/README.md` - `.agents/skills/README.md` - `.mcp.json.example` - `openwiki/INSTRUCTIONS.md` - `.github/workflows/openwiki-update.yml.example` - `.gitignore` - `.github/ISSUE_TEMPLATE.md` - `.github/PULL_REQUEST_TEMPLATE.md` - `.github/CLA.md` - `.vscode/settings.json` - `.vscode/extensions.json` - `.vscode/tasks.json` - `.vscode/project-docs.code-snippets` ## Editing flow Open `AGENTS.md` first to set the project instructions. Add a focused workflow under `.agents/skills/` only after it becomes repeatable. Copy `.mcp.json.example` to `.mcp.json` for local tool integrations and keep all credentials outside the repository. Use the matching snippet from the command palette or by typing its prefix. The snippet bodies use tab stops so you can move through the placeholder sections in order. ## OpenWiki New projects include an OpenWiki scope brief and a disabled GitHub Actions workflow example. Install the CLI, tailor `openwiki/INSTRUCTIONS.md`, then run `openwiki --init`. Once the chosen provider secret and model are configured, rename the workflow example to `openwiki-update.yml` to receive daily documentation-update pull requests. The optional workflow is adapted from the [OpenWiki project](https://github.com/langchain-ai/openwiki), maintained by LangChain and its contributors. OpenWiki is MIT-licensed; the workflow example retains the upstream copyright and permission notice. See the [OpenWiki license](https://github.com/langchain-ai/openwiki/blob/main/LICENSE). ## Development ```bash npm run dev ``` ```bash npm run build ``` ```bash npm run changelog ``` Generated repositories can update their changelog without an npm script: ```bash node scripts/update-changelog.js ```