Skip to content

docs: update README with project overview#13

Merged
chaliy merged 2 commits intomainfrom
claude/bash-filesystem-library-cYGoo
Jan 31, 2026
Merged

docs: update README with project overview#13
chaliy merged 2 commits intomainfrom
claude/bash-filesystem-library-cYGoo

Conversation

@chaliy
Copy link
Contributor

@chaliy chaliy commented Jan 31, 2026

Summary

  • Replace placeholder README with comprehensive documentation
  • Add Quick Start, Built-in Commands, Shell Features sections
  • Document configuration, virtual filesystem, and CLI usage

Implements four major text processing commands:

- jq: JSON processor using the jaq library
  - Field access, array indexing, keys, length
  - Full jq filter syntax support

- grep: Pattern matching using regex crate
  - Flags: -i (case insensitive), -v (invert), -n (line numbers)
  - Flags: -c (count), -l (files), -F (fixed string), -E (extended)

- sed: Stream editor with substitution support
  - s/pattern/replacement/[g] substitution
  - Address ranges (line numbers, $, regex)
  - Delete (d) and print (p) commands
  - In-place editing with -i flag

- awk: Pattern scanning and processing
  - Field splitting with -F option
  - BEGIN/END blocks
  - Pattern matching (regex and expressions)
  - Built-in variables: NR, NF, FNR, FS, OFS, ORS
  - Functions: length, substr, index, split, gsub, sub, toupper, tolower
  - Arithmetic and string operations
  - Compound assignment operators (+=, -=, etc.)

Also fixes single-quoted string handling:
- Added LiteralWord token type for single-quoted strings
- Single-quoted strings no longer undergo variable expansion
- This fixes $1, $2 etc. being incorrectly expanded in awk/sed programs

Test coverage: 177 tests passing

https://claude.ai/code/session_01A16cD8ztbTJs2PB2iHe1Ua
@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@chaliy chaliy merged commit 93f9f98 into main Jan 31, 2026
1 check passed
@chaliy chaliy deleted the claude/bash-filesystem-library-cYGoo branch January 31, 2026 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants