Skip to content

Latest commit

 

History

History
73 lines (42 loc) · 3.75 KB

README.md

File metadata and controls

73 lines (42 loc) · 3.75 KB
Raw

Flame AI 🔥

Flame AI is a CLI for interacting with OpenAI and doing codemods and codegen. It includes an interactive mode and several other specialized commands.

Flame AI screenshot

To run Flame, you need Node v18+ installed and have access to an OpenAI gpt-4 token key. If you need access to gpt-4, here's how to get it.

Once you obtain a key, add OPENAI_API_KEY=... to your system's environment variables (i.e., .zshrc/.bashrc/etc).

Flame works via npx:

npx flame --help

Commands

To see all commands, including some exciting experimental features, check out the Command Reference.

Upgrade: React Native

Flame AI's most effective command is for upgrading React Native apps. You can watch Jamon's live demo at React Native EU 2023 on YouTube.

Run this in the root of your React Native app:

# one-shot upgrade
npx flame upgrade react-native

# recommended interactive mode (much cooler):
npx flame upgrade react-native --interactive

Here's the command with all available options:

npx flame upgrade react-native --interactive --from=0.72.2 --to=auto --list --only=somefile.mm

Read more about flame upgrade react-native in the Command Reference.

Philosophy

AI (specifically large language models like OpenAI's ChatGPT) is a powerful tool. Flame AI is built to be a minimalist CLI that brings a great developer experience and useful tools for making code modifications (codemods) and code generation.

Given that Infinite Red is a React Native consultancy, the bulk of the built-in tools for Flame will be tuned for React Native development; however, the CLI is built to be extensible and we welcome contributions from the community.

A note about costs

Note that Flame AI costs a nominal amount of money to run, via OpenAI's API pricing. In our experiments, running a full React Native upgrade will cost about $0.05 USD or less. We frequently hit around $5 per day total cost when testing it over and over during a full work day. You must ensure you watch the CLI while it's working to ensure it doesn't get stuck in a loop and run up your bill. We are not responsible for any costs incurred by using Flame AI. We don't want those bills either, so we are regularly adding features and checks to avoid these sorts of issues. At this point, running Flame AI in an automated / unmonitored fashion is not recommended.

Limitations

  • You must have gpt-4 or gpt-4-1106-preview access for Flame AI to be useful. Our experiments with gpt-3.5-turbo have been very underwhelming.
  • The biggest limitation for FlameAI is the lack of prompt size. We're experimenting with gpt-4-1106-preview, which has a token size of 128k tokens. This is a huge improvement over gpt-4 which only had 4k or 8k token size.
  • LLMs are not perfect. They can hallucinate, miss stuff, and be generally weird. We're working on ways to mitigate this, but it's a limitation of current generation AI technology.

Contributing, modifying, running locally

See the Contributing Guide.

Get Help

If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.

Feel free to join our community Slack and join the #flame-ai-cli channel here: https://community.infinite.red.

License

Copyright (c) 2023 Jamon Holmgren & Infinite Red, Inc.

This project is open source and licensed under the MIT License.