Skip to content

Commit 4df82b2

Browse files
alessiolidoz-hashalessiolidoz-hash
committed
chore: add trust docs, sanity checks, and examples
1 parent c6786ec commit 4df82b2

File tree

20 files changed

+672
-7
lines changed

20 files changed

+672
-7
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
pull_request:
6+
7+
jobs:
8+
test:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-python@v5
13+
with:
14+
python-version: "3.12"
15+
- name: Run doctor
16+
run: |
17+
PYTHONPATH=src python3 -m hyperclaw_max.doctor --repo .
18+
- name: Run privacy check
19+
run: |
20+
PYTHONPATH=src python3 -m hyperclaw_max.privacy_check --repo .
21+
- name: Run unit tests
22+
run: |
23+
PYTHONPATH=src python3 -m unittest discover -s tests -q

‎CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
## 2026-03-10
4+
5+
- seeded HyperClaw-Max skeleton
6+
- extracted Stage 1 public-safe `context-intel` core
7+
- added product-facing README, hosting/privacy docs, and core boot drafts
8+
- added doctor, privacy-check, CI, and first real examples

‎CITATION.cff‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
cff-version: 1.2.0
2+
title: HyperClaw-Max
3+
message: "If you use HyperClaw-Max, please cite the repository."
4+
type: software
5+
authors:
6+
- family-names: Lidozzi
7+
given-names: Alessio
8+
repository-code: "https://github.com/alessiolidoz-hash/HyperClaw-Max"
9+
license: MIT

‎CONTRIBUTING.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
HyperClaw-Max is still in a pre-public hardening stage.
4+
5+
Current contribution posture:
6+
- issues and PRs are welcome after the repo becomes public
7+
- changes should prefer public-safe abstractions over private-path copies
8+
- adapters must remain optional unless clearly license-compatible and portable
9+
10+
## Contribution Rules
11+
12+
- keep secrets out of the repo
13+
- avoid hard-coded personal or host-specific paths
14+
- prefer synthetic fixtures over real private data
15+
- keep the base distro useful without optional adapters
16+
- keep docs aligned with actual runtime behavior
17+
18+
## Before Opening A PR
19+
20+
Run:
21+
22+
```bash
23+
python3 -m hyperclaw_max.doctor --repo .
24+
python3 -m hyperclaw_max.privacy_check --repo .
25+
python3 -m unittest discover -s tests -q
26+
```

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Alessio Lidozzi
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎SECURITY.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Security Policy
2+
3+
HyperClaw-Max is a local-first agent distro and privacy boundary matters.
4+
5+
## Supported Security Posture
6+
7+
Current stage:
8+
- private staging repo
9+
- pre-public hardening
10+
- no telemetry by default
11+
12+
## Reporting Security Issues
13+
14+
Until the repo is public:
15+
- report privately to the maintainer
16+
- do not open public disclosures
17+
18+
## Security Principles
19+
20+
- no secrets in git
21+
- no live personal runtime state in git
22+
- template-only connector config
23+
- private overlay must remain separable from public core
24+
- optional adapters must not silently weaken the base distro

‎docs/CLI.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# CLI Reference
2+
3+
Current exposed commands:
4+
- `hyperclaw-doctor`
5+
- `hyperclaw-privacy-check`
6+
- `hyperclaw-symbol-slice`
7+
- `hyperclaw-feedback-store`
8+
- `hyperclaw-context-pack`
9+
- `hyperclaw-failure-clinic`
10+
- `hyperclaw-context-baseline`
11+
- `hyperclaw-context-scorecard`
12+
13+
## Minimal Usage
14+
15+
```bash
16+
python3 -m hyperclaw_max.doctor --repo .
17+
python3 -m hyperclaw_max.privacy_check --repo .
18+
python3 -m hyperclaw_max.context_intel.pack "telegram inbound dedupe session scope" --repo . --format human
19+
python3 -m hyperclaw_max.context_intel.clinic --text "memory sync failed (search): openai embeddings failed: 401 provider=openai" --format human
20+
```
21+
22+
## Current Reality
23+
24+
These commands are already real.
25+
They are not yet the full product surface of HyperClaw-Max.

‎docs/phases/PHASE-3-GRANT-GO-READINESS-20260310.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ HyperClaw-Max now has:
2424
- a default persistent-agent pack
2525
- hosting and dependency guidance
2626
- privacy and secret boundaries
27+
- trust docs and repo hygiene surfaces
28+
- CI and generated example outputs
2729
- a separate private GitHub repo
2830
- real extracted code
2931
- tests and synthetic fixtures
@@ -40,6 +42,8 @@ Current positive checks:
4042
- no obvious live secrets found in the latest targeted scan
4143
- core extracted tests pass
4244
- scorecard runs
45+
- doctor passes
46+
- privacy check passes
4347
- private repo exists and is being updated in parallel
4448

4549
## Remaining Gaps

‎docs/phases/PHASE-4-TRUST-LAYER-20260310.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Phase 4 Trust Layer
2+
3+
Date: 2026-03-10
4+
5+
Goal:
6+
- make the repo feel publicly credible, not just technically interesting
7+
8+
Delivered:
9+
- `LICENSE`
10+
- `CONTRIBUTING.md`
11+
- `SECURITY.md`
12+
- `CHANGELOG.md`
13+
- `CITATION.cff`
14+
- `doctor` CLI
15+
- `privacy_check` CLI
16+
- GitHub Actions CI workflow
17+
- generated example outputs
18+
19+
Why it matters:
20+
- reviewers can see policy, hygiene, and execution proof
21+
- the repo now communicates trust, not just ambition

‎examples/README.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Examples
22

3-
This directory will hold:
4-
- example configs
5-
- example onboarding scenarios
6-
- example repo-intelligence usage
7-
- example memory queries across tiers
3+
This directory now holds:
4+
- quickstart examples
5+
- generated output samples
6+
7+
Current intent:
8+
- let a reviewer understand what the current extracted core already does
9+
- make the repo feel runnable, not just conceptual

0 commit comments

Comments
 (0)