Skip to content

Commit

Permalink
chore: update readme and rename project
Browse files Browse the repository at this point in the history
  • Loading branch information
markwylde committed Sep 30, 2024
1 parent d073ac1 commit 6f1ca59
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AI Toolkit (aitk)
# aitk (the ai toolkit)

AI Toolkit is a command-line utility for listing and dumping file contents in a directory structure, designed to assist with AI-related tasks. It now includes functionality to extract types and function signatures from TypeScript and JavaScript files, as well as AI-powered features for asking questions and editing files.

Expand All @@ -7,7 +7,7 @@ AI Toolkit is a command-line utility for listing and dumping file contents in a
To install the AI Toolkit globally, run:

```bash
npm install -g @markwylde/ai-toolkit
npm install -g @markwylde/aitk
```

## Usage
Expand All @@ -31,6 +31,7 @@ export LITELLM_AUTH_TOKEN="your auth token"
- `ls`: Show a recursive directory tree of all files
- `types`: List all types and function signatures for TypeScript and JavaScript files
- `ask`: Ask a question to an AI model
- `prompt`: Ask an AI model to generate a prompt for changing your code
- `edit`: Apply AI-powered edits to files in the current directory
- `help`: Show the help message

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@markwylde/ai-toolkit",
"name": "@markwylde/aitk",
"private": false,
"version": "1.8.0",
"bin": {
Expand Down

0 comments on commit 6f1ca59

Please sign in to comment.