shipgate 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ISL Lang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,184 @@
+# Shipgate CLI
+
+**ShipGate — Stop AI from shipping fake features. Define what your code should do. We enforce it.**
+
+Command-line interface for ISL (Intent Specification Language).
+
+## Installation
+
+```bash
+# Install globally (recommended)
+npm install -g shipgate
+
+# Or use npx (no installation required)
+npx shipgate <command>
+```
+
+## Quick Start
+
+```bash
+# Initialize a new project in the current directory
+npx shipgate init
+
+# Or create a new project directory
+npx shipgate init my-project
+
+# Parse and validate ISL files
+npx shipgate check specs/*.isl
+
+# Generate code from ISL specs
+npx shipgate generate --target typescript specs/
+
+# Verify implementation against spec
+npx shipgate verify specs/example.isl --impl ./src
+
+# Get help
+npx shipgate --help
+```
+
+## Commands
+
+### `shipgate init [name]`
+
+Initialize a new ISL project with recommended structure.
+
+```bash
+# Create project in current directory
+npx shipgate init
+
+# Create a new project directory
+npx shipgate init my-api
+cd my-api
+```
+
+Creates:
+- `isl.config.json` - Project configuration
+- `src/` - Directory for ISL specifications (with example `.isl` file)
+- `generated/` - Output directory for generated code
+- `package.json` - Node.js project file with scripts
+
+### `shipgate check <files...>`
+
+Parse and type-check ISL files.
+
+```bash
+npx shipgate check specs/*.isl
+npx shipgate check --strict specs/
+```
+
+Options:
+- `--strict` - Enable strict mode (all warnings become errors)
+- `--format <format>` - Output format (pretty, json, quiet)
+
+### `shipgate generate <files...>`
+
+Generate code from ISL specifications.
+
+```bash
+# Generate TypeScript
+npx shipgate generate --target typescript specs/
+
+# Generate Python
+npx shipgate generate --target python --output src/generated specs/
+
+# Generate OpenAPI
+npx shipgate generate --target openapi specs/api.isl
+```
+
+Options:
+- `--target, -t` - Target language (typescript, python, rust, go, openapi, graphql)
+- `--output, -o` - Output directory
+- `--config, -c` - Config file path
+
+### `shipgate verify <files...>`
+
+Verify implementation against ISL specifications.
+
+```bash
+npx shipgate verify specs/critical-flow.isl --impl ./src
+```
+
+### `shipgate parse <file>`
+
+Parse an ISL file and display the AST.
+
+```bash
+npx shipgate parse specs/example.isl
+```
+
+### `shipgate gate <files...>`
+
+Run the ShipGate (SHIP/NO-SHIP gate) on ISL files.
+
+```bash
+npx shipgate gate specs/
+npx shipgate gate --ci --output json
+```
+
+### `shipgate repl`
+
+Start an interactive REPL for exploring ISL.
+
+```bash
+npx shipgate repl
+```
+
+## Configuration
+
+The `init` command creates `isl.config.json` in your project root:
+
+```json
+{
+  "defaultTarget": "typescript",
+  "strictMode": true,
+  "outputDir": "./generated",
+  "include": ["src/**/*.isl"],
+  "exclude": ["src/drafts/**"],
+  "output": {
+    "types": true,
+    "tests": true,
+    "docs": false
+  }
+}
+```
+
+## Environment Variables
+
+- `ISL_CONFIG` - Path to config file
+- `ISL_DEBUG` - Enable debug output
+- `ISL_NO_COLOR` - Disable colored output
+- `ANTHROPIC_API_KEY` - API key for AI-enhanced features (optional)
+
+## Examples
+
+### Initialize a project
+
+```bash
+npx shipgate init
+```
+
+This creates:
+- `src/my-project.isl` - Example ISL specification
+- `isl.config.json` - Configuration file
+- `package.json` - Node.js project file
+
+### Check ISL files
+
+```bash
+npx shipgate check src/*.isl
+```
+
+### Generate TypeScript types
+
+```bash
+npx shipgate generate --target typescript src/
+```
+
+## Documentation
+
+- Full documentation: https://shipgate.dev/docs
+- GitHub: https://github.com/guardiavault-oss/ISL-LANG
+
+## License
+
+MIT