-
Notifications
You must be signed in to change notification settings - Fork 0
CLI Commands
The Zero-AI-Trace Framework provides a complete command-line interface with 6 main commands.
# Global installation required
npm install -g zero-ai-trace-framework
# Check installation
zero-ai-trace --version
# General help
zero-ai-trace --helpUsage:
zero-ai-trace validateDescription: Launches interactive framework validation with real-time testing.
Features:
- β Framework structure verification
- β Labeling rules testing
- β Writing style validation
- β AI markers detection
- β Detailed compliance report
Usage Example:
$ zero-ai-trace validate
π― Zero-AI-Trace Framework - Interactive Validation
β
Framework structure: Valid
β
Labeling rules: Compliant
β
Humanization style: Configured
β οΈ Anti-detection: Partially configured
Overall score: 85/100Usage:
zero-ai-trace show [options]Options:
-
--format <type>: Output format (text, json, markdown) -
--compact: Optimized compact version -
--variant <name>: Specific variant
Description: Displays the framework's main prompt in different formats.
Examples:
# Standard prompt
zero-ai-trace show
# Compact version for injection
zero-ai-trace show --compact
# JSON format for API
zero-ai-trace show --format json
# Development variant
zero-ai-trace show --variant devUsage:
zero-ai-trace test [options]Options:
-
--verbose: Detailed output -
--suite <name>: Specific test suite
Description: Runs the complete automated test suite (13 tests).
Tests Included:
- Framework structure and integrity
- Critical keywords coverage
- Labeling rules validation
- Style and humanization tests
- AI patterns detection
- Automatic correction tests
Example:
$ zero-ai-trace test --verbose
π§ͺ Running automated tests...
β
Test 1/13: Framework structure
β
Test 2/13: Critical keywords
β
Test 3/13: Labeling rules
...
β
Test 13/13: Automatic correction
π All tests pass (13/13)
Execution time: 1.2sUsage:
zero-ai-trace build [options]Options:
-
--output <dir>: Output directory -
--variants <list>: Specific variants to generate
Description: Automatically generates 6 prompt variants and integration templates.
Generated Variants:
- compact.txt - Optimized version for injection
- extended.txt - Complete version with explanations
- api.json - Structured format for API
- chatgpt.md - Optimized for ChatGPT web
- system.txt - For system prompts
- dev.txt - Development version with debug
Created Templates:
- ChatGPT Custom Instructions integration
- OpenAI API configuration
- Web frameworks template
Example:
$ zero-ai-trace build --output ./prompts
π¦ Generating variants and templates...
β
compact.txt (1,040 characters)
β
extended.txt (2,840 characters)
β
api.json (Complete structure)
β
chatgpt.md (Formatted markdown)
β
system.txt (System prompt)
β
dev.txt (Debug version)
π Generated templates:
β
ChatGPT Custom Instructions
β
API Integration Template
β
Web Framework Template
π Build completed successfully!Usage:
zero-ai-trace init <project-name> [options]Options:
-
--template <type>: Project template (basic, api, web) -
--language <lang>: Language (js, python, etc.)
Description: Creates a new project with framework integration.
Generated Structures:
my-project/
βββ config/
β βββ zero-ai-trace.json
β βββ prompts/
βββ src/
β βββ framework.js
β βββ examples/
βββ tests/
β βββ framework.test.js
βββ package.json
βββ README.md
Example:
$ zero-ai-trace init my-chatbot --template api --language js
π Initializing project 'my-chatbot'...
β
Basic structure created
β
Zero-AI-Trace configuration
β
API integration templates
β
Automated tests configured
β
Documentation generated
π Project created in: ./my-chatbot
π See README.md to get startedUsage:
zero-ai-trace info [options]Options:
-
--stats: Detailed statistics -
--rules: List of active rules
Description: Displays framework information and statistics.
Displayed Information:
- Framework version
- Number of active rules
- Test statistics
- Current configuration
- Useful links
Example:
$ zero-ai-trace info --stats
π Zero-AI-Trace Framework v1.0.1
π― Current configuration:
ββ Active rules: 15
ββ Available tests: 13
ββ Variants: 6
ββ Templates: 3
π Statistics:
ββ Compact prompt: 1,040 characters
ββ Monitored keywords: 8
ββ Anti-detection patterns: 12
ββ Last validation: β
Passed
π Resources:
ββ Documentation: https://github.com/Darkfall48/Zero-AI-Trace-Framework/wiki
ββ Issues: https://github.com/Darkfall48/Zero-AI-Trace-Framework/issues
ββ Discussions: https://github.com/Darkfall48/Zero-AI-Trace-Framework/discussions# 1. Create a new project
zero-ai-trace init my-project --template api
# 2. Validate configuration
zero-ai-trace validate
# 3. Generate variants
zero-ai-trace build --output ./dist
# 4. Test
zero-ai-trace test --verbose# 1. Get compact prompt
zero-ai-trace show --compact > prompt.txt
# 2. Validate before deployment
zero-ai-trace test
# 3. Get integration templates
zero-ai-trace build --output ./production# 1. Detailed information
zero-ai-trace info --stats
# 2. Validation with debug
zero-ai-trace validate
# 3. Verbose tests
zero-ai-trace test --verbose
# 4. Development prompt
zero-ai-trace show --variant dev# Custom configuration directory
export ZERO_AI_TRACE_CONFIG_DIR="/path/to/config"
# Verbosity level (0-3)
export ZERO_AI_TRACE_VERBOSE=2
# Default output format
export ZERO_AI_TRACE_DEFAULT_FORMAT="json"Create ~/.zero-ai-trace.json:
{
"defaultFormat": "compact",
"autoValidate": true,
"customRules": [],
"outputDirectory": "./zero-ai-trace-output",
"verboseMode": false
}# Check global installation
npm list -g zero-ai-trace-framework
# Reinstall if necessary
npm install -g zero-ai-trace-framework# On Unix/Mac
sudo npm install -g zero-ai-trace-framework
# Or configure npm without sudo
npm config set prefix ~/.npm-global# Check Node.js version (>=14 required)
node --version
# Update if necessary- Getting Started - To get started
- Advanced Guide - Optimizations and techniques
- Examples - Practical use cases
- Troubleshooting - Solutions to common problems
Documentation updated for version 1.0.1