Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: CI

on:
push:
branches: [master]
pull_request:

env:
CARGO_TERM_COLOR: always

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt, clippy
- run: cargo fmt --check
- run: cargo clippy --all-targets -- -D warnings
- run: cargo test
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/target
**/*.rs.bk
.idea/
.vscode/
*.swp
.DS_Store
33 changes: 33 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Agent notes for amendable-cli

Rust CLI (`amendable`) for the Amendable API.

## Product facts (do not invent others)

- Site + Git HTTPS: `https://amendable.io`
- API: `https://api.amendable.io` header `access-token`
- Clone: `https://amendable.io/r/<username>/<repo>.git`
- Git password is the access token. There is no SSH.
- Command name is `amendable`. Package name is `amendable-cli`.

Staging is a config override, not a different command set:

- `amendable --staging` / `amendable login --staging`
- `AMENDABLE_API_URL=https://stage.api.amendable.io`
- `AMENDABLE_APP_URL=https://stage.amendable.io`

Config file: `~/.config/amendable/config.toml` (mode `0600`).

Authoritative API behavior lives in `../amendable-web`. Customer docs live in `../amendable-docs`. If the CLI disagrees with the API, fix the CLI. If the docs disagree with the CLI, fix the docs.

## Commands

Keep the public command surface stable. Docs and examples call `amendable`, not `amendable-cli`.

## Tests

```bash
cargo test
cargo fmt --check
cargo clippy --all-targets -- -D warnings
```
Loading
Loading