Skip to content

docs: simplify the README and move the details into docs/ #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akhileshthite wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: simplify the README and move the details into docs/ #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,20 @@ deno run --allow-net --allow-read=. --allow-write=. --allow-sys --allow-env --al
./build/main.js <command> # after building
```

Available CLI commands:
Available CLI commands (all documented in `docs/commands.md`):
- `chel init` - Generate a template `chel.toml`
- `chel keygen` - Generate cryptographic key pairs
- `chel manifest` - Create signed contract manifests
- `chel verifySignature` - Check a manifest's signature and file hashes
- `chel deploy` - Deploy contracts to a server or directory
- `chel serve` - Start the server with contract preloading
- `chel pin` - Pin contracts to specific versions
- `chel upload` - Upload files to a server or directory
- `chel get` - Print the entry stored under a key
- `chel hash` - Compute CID hash of a file
- `chel migrate` - Migrate data between database backends
- `chel latestState` - Get latest contract state
- `chel eventsAfter` / `chel eventsBefore` - Query contract events
- `chel eventsAfter` - Query contract events
- `chel version` - Print the version

## Project Structure

Expand Down Expand Up @@ -187,4 +190,4 @@ Manifests are JSON with signed body:
3. `git diff --exit-code -- build` to confirm the rebuild is reproducible
4. `npm publish --access public`

See the Packaging section of README.md for the full procedure.
See `docs/distributing.md` for the full procedure.
Loading
Loading