Skip to content

docs: fix README CLI example and add exit codes #78

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
leopoletto wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: fix README CLI example and add exit codes #78

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33a9944
docs: fix README examples to match actual CLI output
leopoletto Aug 28, 2025
da6c46a
Change url → URI in the README
leopoletto Aug 28, 2025
7066f31
docs(README): document empty robots.txt behavior and exit codes
leopoletto Aug 28, 2025
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: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Target //:robots_main up-to-date:
bazel-bin/robots_main
...
bazel-robots$ bazel run robots_main -- ~/local/path/to/robots.txt YourBot https://example.com/url
user-agent 'YourBot' with url 'https://example.com/url' allowed: YES
user-agent 'YourBot' with URI 'https://example.com/url': ALLOWED
```

#### Building with CMake
Expand Down Expand Up @@ -104,8 +104,15 @@ Test project robotstxt/c-build
Total Test time (real) = 0.02 sec
...
$ robots ~/local/path/to/robots.txt YourBot https://example.com/url
user-agent 'YourBot' with url 'https://example.com/url' allowed: YES
user-agent 'YourBot' with URI 'https://example.com/url': ALLOWED
```
> **Note**: If the robots file is empty, the parser also prints:
>
> ```
> notice: robots file is empty so all user-agents are allowed
> ```

> **Exit codes:** `0` = ALLOWED, `1` = DISALLOWED

## Notes

Expand Down