Skip to content

Commit

Permalink
Rename ss script to ai
Browse files Browse the repository at this point in the history
  • Loading branch information
danielcampagnolitg committed Feb 10, 2025
1 parent f0d09b9 commit e453097
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
File renamed without changes.
18 changes: 9 additions & 9 deletions docs/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Then from any folder you can run commands like:

`ss query what test frameworks does this repository use`

Where *query* is the TypedAI package.json script. For all the examples in the CLI scripts section above you can replace `npm run` with `ss`
Where *query* is the TypedAI package.json script. For all the examples in the CLI scripts section above you can replace `npm run` with `ai`


### CLI scripts
Expand All @@ -56,7 +56,7 @@ There are a number of convenience scripts in the package.json for running agents

### agent

`npm run agent` or `ss agent` will run the autonomous agent configured in `src/cli/agent.ts`. Note that the agent will have the functions available configured in the `agent.ts` file.
`npm run agent` or `ai agent` will run the autonomous agent configured in `src/cli/agent.ts`. Note that the agent will have the functions available configured in the `agent.ts` file.

If no arguments are supplied the user prompt will be read from `src/cli/agent-in`

Expand All @@ -69,7 +69,7 @@ npm run agent research the latest news about large language models and write a r

### code

`npm run code` or `ss code` runs the [CodeEditingAgent](/software-engineer/) configured in `src/cli/code.ts`
`npm run code` or `ai code` runs the [CodeEditingAgent](/software-engineer/) configured in `src/cli/code.ts`

Without arguments the prompt is read from `src/cli/code-in` otherwise it uses the provided arguments for the prompt.

Expand All @@ -84,17 +84,17 @@ directory set to the current shell directory.

### index

`npm run index` or `ss index`
`npm run index` or `ai index`

This runs the agent which indexes a repository, and stores the summary index docs under `.typedai/docs`

### slack

`npm run slack` or `ss slack` starts the Slack chatbot. The chatbot will have the functions available defined in `src/modules/slack/slackChatBotService.ts`
`npm run slack` or `ai slack` starts the Slack chatbot. The chatbot will have the functions available defined in `src/modules/slack/slackChatBotService.ts`

### swe

`npm run swe` or `ss swe` runs the SoftwareDeveloperAgent configured in `src/cli/swe.ts`
`npm run swe` or `ai swe` runs the SoftwareDeveloperAgent configured in `src/cli/swe.ts`

Without arguments the prompt is read from `src/cli/swe-in` otherwise it uses the provided arguments for the prompt.

Expand All @@ -104,7 +104,7 @@ This agent can be used for process automation and handling requests within the l

### gen

`npm run gen` or `ss gen` runs the script at `src/cli/gen.ts`
`npm run gen` or `ai gen` runs the script at `src/cli/gen.ts`

This simply generates text from a prompt. As with the other scripts you can provide arguments for a quick prompt.
Otherwise, prepare the prompt in `src/cli/gen-in` and don't provide any other arguments.
Expand All @@ -125,15 +125,15 @@ Make sure the directory you save the files to is in the .gitignore.

### scrape

`npm run scrape <url>` or `ss scrape <url>` runs the PublicWeb.getWebPage function which uses a headless browser to scrape a web page, and then converts
`npm run scrape <url>` or `ai scrape <url>` runs the PublicWeb.getWebPage function which uses a headless browser to scrape a web page, and then converts
it to a slim format by using the `@mozilla/readability` module to first extract the main contents of the page, and then the `turndown`
package to convert the HTML to Markdown, further reducing the token count.

By default, it writes the output to `scrape.md`. Alternatively you can provide an argument for the file to write to.

### query

`npm run query <question>` or `ss query <question>` runs the codebase query agent at *src/swe/discovery/fileSelectionAgent.ts* which can answer ad hoc
`npm run query <question>` or `ai query <question>` runs the codebase query agent at *src/swe/discovery/fileSelectionAgent.ts* which can answer ad hoc
questions about a codebase/folder contents.

## Development
Expand Down
2 changes: 1 addition & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ site_name: TypedAI
site_url: https://typedai.dev/
theme:
name: material
logo: assets/s.png
logo: assets/tai.png
palette:
primary: black
icon:
Expand Down

0 comments on commit e453097

Please sign in to comment.