An AI powered command-line tool for generating any books from scratch
Here is a book written based on abook:
📚 Python Guide for JavaScript Engineers | Read it online
Run cp .env.example .env then fill the .env file:
- OPENAI_API_KEY: Required, string, type your open api key
- OPENAI_MODEL: Required, string, type your open ai model name
- OPENAI_BASE_URL: Optional, string, type your custom openai api url
- VERBOSE: Optional,
trueorfalse, determine whether or not to print conversation details when interacting with openai
You can install abook as a global command as following:
yarn global add @luckrnx09/abookor
npm install -g @luckrnx09/abookor
pnpm install -g @luckrnx09/abookThen you can use abook -V to print the abook version installed.
If you don't want to install it globally, you can use npx to run abook directly:
npx @luckrnx09/abook| command | description |
|---|---|
| ls | list all the ideas |
| new | create an idea |
| outline <idea> | generate outline from an idea |
| publish <idea> | convert book content to markdown |
| rm <idea> | remove an idea |
| run <idea> | generate book content from an idea with outline |
| help [command] | display help for command |
TODO
Any code enhancements, documentation updates, unit tests are welcome.
Any changes that alter functionality, please submit an issue first.
This project is under MIT license