https://github.com/newdesignfile/agents
[WIP] Generate AI agent policy files for web apps and sites.
https://github.com/newdesignfile/agents
Last synced: about 1 month ago
JSON representation
[WIP] Generate AI agent policy files for web apps and sites.
- Host: GitHub
- URL: https://github.com/newdesignfile/agents
- Owner: NewDesignFile
- Created: 2025-01-26T18:09:31.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-27T17:03:16.000Z (3 months ago)
- Last Synced: 2025-01-27T18:25:48.953Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# New UI Agents
Generate AI agent policy files (`ai-policy.json`, `agents.json`, `llms.txt`) for web apps and sites.
- Generate AI agent policy files with a single command.
- Validate generated files against JSON schemas.
- Customize output directory and file selection.
- Integrate into your project's build or setup process.
### Installation
Install the package locally in your project:
```bash
npm install @new-ui/agents --save-dev
```
### Usage
Add a Script to `package.json` to easily generate policy files:
```json
{
"scripts": {
"generate-policies": "agents init"
}
}
```
### Generate Policy Files
```bash
npm run generate-policies
```
### Customize Output Directory
```bash
npm run generate-policies -- --dir public/ai-config
```
### Generate Specific Files
```bash
npm run generate-policies -- --files ai-policy.json,llms.txt
```
### Disable Validation
```bash
npm run generate-policies -- --no-validate
```