kyprss / ai-docs
An easy tool to download the latest documentation from a git repository
Installs: 1 444
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/kyprss/ai-docs
Requires
- php: ^8.3
- symfony/console: ^7.0
- symfony/dependency-injection: ^7.0
- symfony/filesystem: ^7.0
- symfony/process: ^7.0
Requires (Dev)
- laravel/pint: ^1.24
This package is auto-updated.
Last update: 2025-12-10 12:16:26 UTC
README
AI Docs is an easy tool to download the latest documentation from a git repository. It creates a reference file which you can use in your AI guidelines.
Installation
Install via Composer:
composer require kyprss/ai-docs
Usage
/vendor/bin/ai-docs
Initialization
/vendor/bin/ai-docs init
On the first run a config file ai-docs.json will be created in the root directory of your project.
The file will be look like this:
{
"config": {
"target_path": ".ai/docs/"
},
"sources": {
"laravel": {
"type": "repository",
"url": "git@github.com:laravel/docs.git",
'branch' => '12.x',
"files": ["*.md"]
},
"plentyone-rest-api": {
"type": "openapi3",
"url": "https://raw.githubusercontent.com/plentymarkets/api-doc/refs/heads/master/plentymarkets/openApiV3/openApiV3WithExamples.json"
}
}
}
Sync
/vendor/bin/ai-docs sync
This command will sync all given sources by doing the following steps:
- downloading the latest files from the git repo to temp directory
- matching all files with the given patterns
- copy the found files to
{target_path}/{name}/