Skip to content

Document --dry flag and build from source in README #30

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

Merged
TomasVotruba merged 1 commit into from
Sep 16, 2026
Merged

Document --dry flag and build from source in README #30

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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,14 @@ $this->handle("text"); // string -> parameter is left untyped
go install github.com/rectorphp/argtyper@latest
```

Or build from source:

```bash
git clone https://github.com/rectorphp/argtyper
cd argtyper
make build # produces ./argtyper
```

## Usage

```bash
Expand All @@ -116,6 +124,15 @@ argtyper add-types [project-path]
`project-path` defaults to the current directory. The tool scans the `src`,
`lib`, `app`, `test` and `tests` directories.

Preview the changes without writing them with `--dry`:

```bash
argtyper add-types . --dry
```

It prints the diff of the types that would be added and leaves every file
untouched.

<br>

## How it works
Expand Down
Loading