Compare commits
2 Commits
dependabot
...
main
Author | SHA1 | Date | |
---|---|---|---|
![]() |
c2a01f9b62 | ||
![]() |
e287652c25 |
28
README.md
28
README.md
@@ -1,25 +1,21 @@
|
|||||||
# toak
|
# code-tokenizer
|
||||||
it's no joke
|
|
||||||
|
|
||||||
[](https://www.npmjs.com/package/toak)
|
[](https://www.npmjs.com/package/toak)
|
||||||

|

|
||||||
[](https://www.gnu.org/licenses/agpl-3.0.html)
|
[](https://www.gnu.org/licenses/agpl-3.0.html)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
`toak` is an intentionally simple yet powerful tool that processes git repository files, cleans code, redacts sensitive information, and generates markdown documentation with token counts using the Llama 3 tokenizer.
|
`toak` is a cli tool, named for phonetics, that processes git repository files, cleans code, redacts sensitive information, and generates a `prompt.md` with token counts using the Llama 3 tokenizer.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ cd your-git-repo
|
$ cd your-git-repo
|
||||||
$ npx toak
|
$ npx toak
|
||||||
```
|
```
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Philosophy
|
|
||||||
1. _Human-first_ technologies for a better future.
|
|
||||||
2. If you don't like the name...good.
|
|
||||||
---
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
@@ -29,14 +25,10 @@ $ npx toak
|
|||||||
- Redacts sensitive information (API keys, tokens, JWT, hashes)
|
- Redacts sensitive information (API keys, tokens, JWT, hashes)
|
||||||
- Counts tokens using llama3-tokenizer-js
|
- Counts tokens using llama3-tokenizer-js
|
||||||
- Supports nested .toak-ignore files
|
- Supports nested .toak-ignore files
|
||||||
|
|
||||||
### Token Cleaning
|
|
||||||
- Removes single-line and multi-line comments
|
- Removes single-line and multi-line comments
|
||||||
- Strips console.log statements
|
- Strips console.log statements
|
||||||
- Removes import statements
|
- Removes import statements
|
||||||
- Cleans up whitespace and empty lines
|
- Cleans up whitespace and empty lines
|
||||||
|
|
||||||
### Security Features
|
|
||||||
- Redacts API keys and secrets
|
- Redacts API keys and secrets
|
||||||
- Masks JWT tokens
|
- Masks JWT tokens
|
||||||
- Hides authorization tokens
|
- Hides authorization tokens
|
||||||
@@ -45,15 +37,7 @@ $ npx toak
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Node.js (>=14.0.0)
|
- npm/bun/yarn/pnpm
|
||||||
- Git repository
|
|
||||||
- Bun runtime (for development)
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm install toak
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user