| Name | specfact-cli JSON |
| Version |
0.4.2
JSON |
| download |
| home_page | None |
| Summary | SpecFact CLI - Spec→Contract→Sentinel tool for contract-driven development with automated quality gates |
| upload_time | 2025-11-06 00:36:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | # Sustainable Use License
Version 1.0
## Acceptance
By using the software, you agree to all of the terms and conditions below.
## Copyright License
The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations below.
## Limitations
You may use or modify the software only for your own internal business purposes or for non-commercial or personal use. You may distribute the software or provide it to others only if you do so free of charge for non-commercial purposes. You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software.
## Trademarks
**NOLD AI** (also referred to as **NOLDAI**) is a registered trademark (wordmark) at the European Union Intellectual Property Office (EUIPO). All rights to the NOLD AI trademark are reserved.
Any use of the licensor's trademarks is subject to applicable law. All other trademarks, service marks, and trade names mentioned in this software are the property of their respective owners. See [TRADEMARKS.md](TRADEMARKS.md) for a complete list of third-party trademarks and their respective owners.
## Patents
The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
## Notices
You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms. If you modify the software, you must include in any modified copies of the software a prominent notice stating that you have modified the software.
## No Other Rights
These terms do not imply any licenses other than those expressly granted in these terms.
## Termination
If you use the software in violation of these terms, such use is not licensed, and your license will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your license will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your license to terminate automatically and permanently.
## No Liability
As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
## Definitions
The "licensor" is Nold AI (Owner: Dominikus Nold).
The "software" is the SpecFact CLI software the licensor makes available under these terms, including any portion of it.
"You" refers to the individual or entity agreeing to these terms.
"Your company" is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. Control means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
"Your license" is the license granted to you for the software under these terms.
"Use" means anything you do with the software requiring your license.
"Trademark" means trademarks, service marks, and similar rights.
---
Copyright (c) 2025 Nold AI (Owner: Dominikus Nold) |
| keywords |
async
beartype
cli
contract-driven-development
contracts
crosshair
icontract
property-based-testing
quality-gates
spec-first
specfact
state-machine
tdd
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# SpecFact CLI
> **Stop "vibe coding", start shipping quality code with contracts**
[](LICENSE.md)
[](https://www.python.org/)
[](https://github.com/nold-ai/specfact-cli)
---
## What is SpecFact CLI?
A command-line tool that helps you write better code by enforcing **contracts** - rules that catch bugs before they reach production.
Think of it as a **quality gate** for your development workflow that:
- ✅ Catches async bugs automatically
- ✅ Validates your code matches your specs
- ✅ Blocks bad code from merging
- ✅ Works offline, no cloud required
**Perfect for:** Teams who want to ship faster without breaking things.
---
## Quick Start
### Install in 10 seconds
```bash
# Zero-install (just run it)
uvx --from specfact-cli specfact --help
# Or install with pip
pip install specfact-cli
```
### Your first command (< 60 seconds)
```bash
# Starting a new project?
specfact plan init --interactive
# Have existing code?
specfact import from-code --repo . --name my-project
# Using GitHub Spec-Kit?
specfact import from-spec-kit --repo ./my-project --dry-run
```
That's it! 🎉
---
## See It In Action
We ran SpecFact CLI **on itself** to prove it works:
- ⚡ Analyzed 32 Python files → Discovered **32 features** and **81 stories** in **3 seconds**
- 🚫 Set enforcement to "balanced" → **Blocked 2 HIGH violations** (as configured)
- 📊 Compared manual vs auto-derived plans → Found **24 deviations** in **5 seconds**
**Total time**: < 10 seconds | **Total value**: Found real naming inconsistencies and undocumented features
👉 **[Read the complete example](docs/examples/dogfooding-specfact-cli.md)** with actual commands and outputs
---
## What Can You Do?
### 1. 🔄 Import from GitHub Spec-Kit
Already using Spec-Kit? **Level up to automated enforcement** in one command:
```bash
specfact import from-spec-kit --repo ./spec-kit-project --write
```
**Result**: Your Spec-Kit artifacts become production-ready contracts with automated quality gates.
### 2. 🔍 Analyze Your Existing Code
Turn brownfield code into a clean spec:
```bash
specfact import from-code --repo . --name my-project
```
**Result**: Auto-generated plan showing what your code actually does
### 3. 📋 Plan New Features
Start with a spec, not with code:
```bash
specfact plan init --interactive
specfact plan add-feature --key FEATURE-001 --title "User Login"
```
**Result**: Clear acceptance criteria before writing any code
### 4. 🛡️ Enforce Quality
Set rules that actually block bad code:
```bash
specfact enforce stage --preset balanced
```
**Modes:**
- `minimal` - Just observe, never block
- `balanced` - Block critical bugs, warn on others
- `strict` - Block everything suspicious
### 5. ✅ Validate Everything
One command to check it all:
```bash
specfact repro
```
**Checks:** Contracts, types, async patterns, state machines
---
## Documentation
For complete documentation, see **[docs/README.md](docs/README.md)**.
**Quick Links:**
- 📖 **[Getting Started](docs/getting-started/README.md)** - Installation and first steps
- 🎯 **[The Journey: From Spec-Kit to SpecFact](docs/guides/speckit-journey.md)** - Level up from interactive authoring to automated enforcement
- 📋 **[Command Reference](docs/reference/commands.md)** - All commands with examples
- 🤖 **[IDE Integration](docs/guides/ide-integration.md)** - Set up slash commands in your IDE
- 💡 **[Use Cases](docs/guides/use-cases.md)** - Real-world scenarios
---
## Installation Options
### 1. uvx (Easiest)
No installation needed:
```bash
uvx --from specfact-cli specfact plan init
```
### 2. pip
Install globally:
```bash
pip install specfact-cli
specfact --help
```
### 3. Docker
Run in a container:
```bash
docker run ghcr.io/nold-ai/specfact-cli:latest --help
```
---
## Project Documentation
### 📚 Online Documentation
**GitHub Pages**: Full documentation is available at `https://nold-ai.github.io/specfact-cli/`
The documentation includes:
- Getting Started guides
- Complete command reference
- IDE integration setup
- Use cases and examples
- Architecture overview
- Testing procedures
**Note**: The GitHub Pages workflow is configured and will automatically deploy when changes are pushed to the `main` branch. Enable GitHub Pages in your repository settings to activate the site.
### 📖 Local Documentation
All documentation is in the [`docs/`](docs/) directory:
- **[Documentation Index](docs/README.md)** - Complete documentation overview
- **[Getting Started](docs/getting-started/installation.md)** - Installation and setup
- **[Command Reference](docs/reference/commands.md)** - All available commands
- **[IDE Integration](docs/guides/ide-integration.md)** - Set up slash commands
- **[Use Cases](docs/guides/use-cases.md)** - Real-world scenarios
---
## Contributing
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
```bash
git clone https://github.com/nold-ai/specfact-cli.git
cd specfact-cli
pip install -e ".[dev]"
hatch run contract-test-full
```
---
## License
**Sustainable Use License** - Free for internal business use
### ✅ You Can
- Use it for your business (internal tools, automation)
- Modify it for your own needs
- Provide consulting services using SpecFact CLI
### ❌ You Cannot
- Sell it as a SaaS product
- White-label and resell
- Create competing products
For commercial licensing, contact [hello@noldai.com](mailto:hello@noldai.com)
**Full license**: [LICENSE.md](LICENSE.md) | **FAQ**: [USAGE-FAQ.md](USAGE-FAQ.md)
---
## Support
- 💬 **Questions?** [GitHub Discussions](https://github.com/nold-ai/specfact-cli/discussions)
- 🐛 **Found a bug?** [GitHub Issues](https://github.com/nold-ai/specfact-cli/issues)
- 📧 **Need help?** [hello@noldai.com](mailto:hello@noldai.com)
---
> **Built with ❤️ by [NOLD AI](https://noldai.com)**
Copyright © 2025 Nold AI (Owner: Dominikus Nold)
**Trademarks**: NOLD AI (NOLDAI) is a registered trademark (wordmark) at the European Union Intellectual Property Office (EUIPO). All other trademarks mentioned in this project are the property of their respective owners. See [TRADEMARKS.md](TRADEMARKS.md) for more information.
Raw data
{
"_id": null,
"home_page": null,
"name": "specfact-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "async, beartype, cli, contract-driven-development, contracts, crosshair, icontract, property-based-testing, quality-gates, spec-first, specfact, state-machine, tdd",
"author": null,
"author_email": "\"NOLD AI (Owner: Dominikus Nold)\" <hello@noldai.com>",
"download_url": "https://files.pythonhosted.org/packages/ed/d6/830e927fde5f80c04d4826f7d9b97f3b835299ac0e2aeb29dae433296a35/specfact_cli-0.4.2.tar.gz",
"platform": null,
"description": "# SpecFact CLI\n\n> **Stop \"vibe coding\", start shipping quality code with contracts**\n\n[](LICENSE.md)\n[](https://www.python.org/)\n[](https://github.com/nold-ai/specfact-cli)\n\n---\n\n## What is SpecFact CLI?\n\nA command-line tool that helps you write better code by enforcing **contracts** - rules that catch bugs before they reach production.\n\nThink of it as a **quality gate** for your development workflow that:\n\n- \u2705 Catches async bugs automatically\n- \u2705 Validates your code matches your specs\n- \u2705 Blocks bad code from merging\n- \u2705 Works offline, no cloud required\n\n**Perfect for:** Teams who want to ship faster without breaking things.\n\n---\n\n## Quick Start\n\n### Install in 10 seconds\n\n```bash\n# Zero-install (just run it)\nuvx --from specfact-cli specfact --help\n\n# Or install with pip\npip install specfact-cli\n```\n\n### Your first command (< 60 seconds)\n\n```bash\n# Starting a new project?\nspecfact plan init --interactive\n\n# Have existing code?\nspecfact import from-code --repo . --name my-project\n\n# Using GitHub Spec-Kit?\nspecfact import from-spec-kit --repo ./my-project --dry-run\n```\n\nThat's it! \ud83c\udf89\n\n---\n\n## See It In Action\n\nWe ran SpecFact CLI **on itself** to prove it works:\n\n- \u26a1 Analyzed 32 Python files \u2192 Discovered **32 features** and **81 stories** in **3 seconds**\n- \ud83d\udeab Set enforcement to \"balanced\" \u2192 **Blocked 2 HIGH violations** (as configured)\n- \ud83d\udcca Compared manual vs auto-derived plans \u2192 Found **24 deviations** in **5 seconds**\n\n**Total time**: < 10 seconds | **Total value**: Found real naming inconsistencies and undocumented features\n\n\ud83d\udc49 **[Read the complete example](docs/examples/dogfooding-specfact-cli.md)** with actual commands and outputs\n\n---\n\n## What Can You Do?\n\n### 1. \ud83d\udd04 Import from GitHub Spec-Kit\n\nAlready using Spec-Kit? **Level up to automated enforcement** in one command:\n\n```bash\nspecfact import from-spec-kit --repo ./spec-kit-project --write\n```\n\n**Result**: Your Spec-Kit artifacts become production-ready contracts with automated quality gates.\n\n### 2. \ud83d\udd0d Analyze Your Existing Code\n\nTurn brownfield code into a clean spec:\n\n```bash\nspecfact import from-code --repo . --name my-project\n```\n\n**Result**: Auto-generated plan showing what your code actually does\n\n### 3. \ud83d\udccb Plan New Features\n\nStart with a spec, not with code:\n\n```bash\nspecfact plan init --interactive\nspecfact plan add-feature --key FEATURE-001 --title \"User Login\"\n```\n\n**Result**: Clear acceptance criteria before writing any code\n\n### 4. \ud83d\udee1\ufe0f Enforce Quality\n\nSet rules that actually block bad code:\n\n```bash\nspecfact enforce stage --preset balanced\n```\n\n**Modes:**\n\n- `minimal` - Just observe, never block\n- `balanced` - Block critical bugs, warn on others\n- `strict` - Block everything suspicious\n\n### 5. \u2705 Validate Everything\n\nOne command to check it all:\n\n```bash\nspecfact repro\n```\n\n**Checks:** Contracts, types, async patterns, state machines\n\n---\n\n## Documentation\n\nFor complete documentation, see **[docs/README.md](docs/README.md)**.\n\n**Quick Links:**\n\n- \ud83d\udcd6 **[Getting Started](docs/getting-started/README.md)** - Installation and first steps\n- \ud83c\udfaf **[The Journey: From Spec-Kit to SpecFact](docs/guides/speckit-journey.md)** - Level up from interactive authoring to automated enforcement\n- \ud83d\udccb **[Command Reference](docs/reference/commands.md)** - All commands with examples\n- \ud83e\udd16 **[IDE Integration](docs/guides/ide-integration.md)** - Set up slash commands in your IDE\n- \ud83d\udca1 **[Use Cases](docs/guides/use-cases.md)** - Real-world scenarios\n\n---\n\n## Installation Options\n\n### 1. uvx (Easiest)\n\nNo installation needed:\n\n```bash\nuvx --from specfact-cli specfact plan init\n```\n\n### 2. pip\n\nInstall globally:\n\n```bash\npip install specfact-cli\nspecfact --help\n```\n\n### 3. Docker\n\nRun in a container:\n\n```bash\ndocker run ghcr.io/nold-ai/specfact-cli:latest --help\n```\n\n---\n\n## Project Documentation\n\n### \ud83d\udcda Online Documentation\n\n**GitHub Pages**: Full documentation is available at `https://nold-ai.github.io/specfact-cli/`\n\nThe documentation includes:\n\n- Getting Started guides\n- Complete command reference\n- IDE integration setup\n- Use cases and examples\n- Architecture overview\n- Testing procedures\n\n**Note**: The GitHub Pages workflow is configured and will automatically deploy when changes are pushed to the `main` branch. Enable GitHub Pages in your repository settings to activate the site.\n\n### \ud83d\udcd6 Local Documentation\n\nAll documentation is in the [`docs/`](docs/) directory:\n\n- **[Documentation Index](docs/README.md)** - Complete documentation overview\n- **[Getting Started](docs/getting-started/installation.md)** - Installation and setup\n- **[Command Reference](docs/reference/commands.md)** - All available commands\n- **[IDE Integration](docs/guides/ide-integration.md)** - Set up slash commands\n- **[Use Cases](docs/guides/use-cases.md)** - Real-world scenarios\n\n---\n\n## Contributing\n\nWe welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n```bash\ngit clone https://github.com/nold-ai/specfact-cli.git\ncd specfact-cli\npip install -e \".[dev]\"\nhatch run contract-test-full\n```\n\n---\n\n## License\n\n**Sustainable Use License** - Free for internal business use\n\n### \u2705 You Can\n\n- Use it for your business (internal tools, automation)\n- Modify it for your own needs\n- Provide consulting services using SpecFact CLI\n\n### \u274c You Cannot\n\n- Sell it as a SaaS product\n- White-label and resell\n- Create competing products\n\nFor commercial licensing, contact [hello@noldai.com](mailto:hello@noldai.com)\n\n**Full license**: [LICENSE.md](LICENSE.md) | **FAQ**: [USAGE-FAQ.md](USAGE-FAQ.md)\n\n---\n\n## Support\n\n- \ud83d\udcac **Questions?** [GitHub Discussions](https://github.com/nold-ai/specfact-cli/discussions)\n- \ud83d\udc1b **Found a bug?** [GitHub Issues](https://github.com/nold-ai/specfact-cli/issues)\n- \ud83d\udce7 **Need help?** [hello@noldai.com](mailto:hello@noldai.com)\n\n---\n\n> **Built with \u2764\ufe0f by [NOLD AI](https://noldai.com)**\n\nCopyright \u00a9 2025 Nold AI (Owner: Dominikus Nold)\n\n**Trademarks**: NOLD AI (NOLDAI) is a registered trademark (wordmark) at the European Union Intellectual Property Office (EUIPO). All other trademarks mentioned in this project are the property of their respective owners. See [TRADEMARKS.md](TRADEMARKS.md) for more information.\n",
"bugtrack_url": null,
"license": "# Sustainable Use License\n \n Version 1.0\n \n ## Acceptance\n \n By using the software, you agree to all of the terms and conditions below.\n \n ## Copyright License\n \n The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations below.\n \n ## Limitations\n \n You may use or modify the software only for your own internal business purposes or for non-commercial or personal use. You may distribute the software or provide it to others only if you do so free of charge for non-commercial purposes. You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software.\n \n ## Trademarks\n \n **NOLD AI** (also referred to as **NOLDAI**) is a registered trademark (wordmark) at the European Union Intellectual Property Office (EUIPO). All rights to the NOLD AI trademark are reserved.\n \n Any use of the licensor's trademarks is subject to applicable law. All other trademarks, service marks, and trade names mentioned in this software are the property of their respective owners. See [TRADEMARKS.md](TRADEMARKS.md) for a complete list of third-party trademarks and their respective owners.\n \n ## Patents\n \n The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.\n \n ## Notices\n \n You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms. If you modify the software, you must include in any modified copies of the software a prominent notice stating that you have modified the software.\n \n ## No Other Rights\n \n These terms do not imply any licenses other than those expressly granted in these terms.\n \n ## Termination\n \n If you use the software in violation of these terms, such use is not licensed, and your license will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your license will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your license to terminate automatically and permanently.\n \n ## No Liability\n \n As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.\n \n ## Definitions\n \n The \"licensor\" is Nold AI (Owner: Dominikus Nold).\n \n The \"software\" is the SpecFact CLI software the licensor makes available under these terms, including any portion of it.\n \n \"You\" refers to the individual or entity agreeing to these terms.\n \n \"Your company\" is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. Control means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.\n \n \"Your license\" is the license granted to you for the software under these terms.\n \n \"Use\" means anything you do with the software requiring your license.\n \n \"Trademark\" means trademarks, service marks, and similar rights.\n \n ---\n \n Copyright (c) 2025 Nold AI (Owner: Dominikus Nold)",
"summary": "SpecFact CLI - Spec\u2192Contract\u2192Sentinel tool for contract-driven development with automated quality gates",
"version": "0.4.2",
"project_urls": {
"Documentation": "https://github.com/nold-ai/specfact-cli#readme",
"Homepage": "https://github.com/nold-ai/specfact-cli",
"Issues": "https://github.com/nold-ai/specfact-cli/issues",
"Repository": "https://github.com/nold-ai/specfact-cli.git",
"Trademarks": "https://github.com/nold-ai/specfact-cli/blob/main/TRADEMARKS.md"
},
"split_keywords": [
"async",
" beartype",
" cli",
" contract-driven-development",
" contracts",
" crosshair",
" icontract",
" property-based-testing",
" quality-gates",
" spec-first",
" specfact",
" state-machine",
" tdd"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "5f91dccc1577d9c93f1725677290fe6ea7cc1f08b2d6b3258884795e36a3ac22",
"md5": "c9979ab158cb46f4bc7434809c18b8fa",
"sha256": "d9f45a75f2cea8e4d146979fe2117bf9cbeb8a31cb3a097feebebf1bc489fe37"
},
"downloads": -1,
"filename": "specfact_cli-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c9979ab158cb46f4bc7434809c18b8fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 137756,
"upload_time": "2025-11-06T00:36:23",
"upload_time_iso_8601": "2025-11-06T00:36:23.131588Z",
"url": "https://files.pythonhosted.org/packages/5f/91/dccc1577d9c93f1725677290fe6ea7cc1f08b2d6b3258884795e36a3ac22/specfact_cli-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "edd6830e927fde5f80c04d4826f7d9b97f3b835299ac0e2aeb29dae433296a35",
"md5": "b8199a23465e20f13495e7ea5a3eeb81",
"sha256": "cf324255f8d5c7334bb6a6a63e491deb82c6b05b9fa409b1bfa31c532f4abfc0"
},
"downloads": -1,
"filename": "specfact_cli-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "b8199a23465e20f13495e7ea5a3eeb81",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 115446,
"upload_time": "2025-11-06T00:36:25",
"upload_time_iso_8601": "2025-11-06T00:36:25.395828Z",
"url": "https://files.pythonhosted.org/packages/ed/d6/830e927fde5f80c04d4826f7d9b97f3b835299ac0e2aeb29dae433296a35/specfact_cli-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-06 00:36:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nold-ai",
"github_project": "specfact-cli#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "specfact-cli"
}
