before-signing

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #claude-code #codex #cli #developer-tools #react #windows

★ 110 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Before Signing Community Edition

Before Signing is a macOS-first contract redaction and review workbench. It is
now offered free of charge as an open-source Community Edition so that lawyers,
developers, researchers, and future maintainers can inspect, adapt, and extend
the workflow.

**中文定位：Before-signing：永久免费、开源的可自成长合同本地脱敏与审查工具。**

Source: [github.com/Shane8989/before-signing](https://github.com/Shane8989/before-signing)
Signed macOS release: [Community Edition 2.0.1](https://github.com/Shane8989/before-signing/releases/tag/v2.0.1-community)

中文说明（含本地脱敏的工作边界与使用建议）：[README.zh-CN.md](README.zh-CN.md)

The software assists with pre-signing work such as local redaction, sensitive
information scanning, contract review, review-rule reuse, suggested edits, and
Word exports. It is not a law firm, does not provide legal advice, and does not
replace a qualified professional's judgment.

## License

The project is licensed under [GNU AGPL-3.0-or-later](LICENSE). This is a
deliberate choice: the PDF redaction and review path uses PyMuPDF, which is
available under AGPL-3.0 or a separate commercial license. If you distribute a
modified build or make a modified version available over a network, comply with
the AGPL's corresponding-source requirements. See
[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).

## What is included

- Local redaction for DOC/DOCX, XLSX, and text-based PDF documents.
- Contract review workbench, including risk suggestions and Word exports.
- Optional local NER assistance and optional user-configured model providers.
- A macOS Tauri application, Python processing engine, and the public website
  source.

PDF support is on by default in the Community Edition. Scanned/image-only PDFs
need OCR before the current text-based PDF workflow can process them. A
downstream minimal build can set `CONTRACT_TOOL_DISABLE_PDF=1` if it deliberately
does not bundle PyMuPDF.

## Run locally

### Python engine

```bash
python3 -m venv .venv
.venv/bin/pip install -r requirements.txt
PYTHONPATH=python .venv/bin/python -m pytest python/contract_tool/tests
```

### macOS application

```bash
cd gui
npm install
npm run tauri dev
```

The desktop shell uses the Python package from `../python` in development. For
a distributable sidecar, see `scripts/build_sidecar.sh` and
`build/contract-tool.spec`.

### Website

```bash
cd marketing-site
npm install
npm run dev
```

The included Cloudflare worker retires historic payment, entitlement, and
checkout routes. Community Edition builds do not require any payment or
licensing secret. See the release checklist before publishing changes.

## Data and model boundaries

- Core file handling is local to the user's computer.
- Optional cloud-model review requests go directly from the user's machine to
  the provider configured by that user; model choice, cost, and data policy are
  the user's responsibility.
- Local Ollama support is optional and remains local when configured locally.
- Never add real client contracts, personal data, API keys, signing keys,
  recovery codes, or account exports to this repository.

## Contributing

Read [CONTRIBUTING.md](CONTRIBUTING.md), [SECURITY.md](SECURITY.md), and
[OPEN_SOURCE_RELEASE_CHECKLIST.md](OPEN_SOURCE_RELEASE_CHECKLIST.md) before
opening an issue, publishing a build, or mirroring this repository.

before-signing

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README