Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,39 @@
# @e18e/cli

This is currently a very early work in progress repository for tracking
the new [e18e](https://e18e.dev) CLI.
![hero](./public/banner.png)

**Nothing usable exists here yet.**
The e18e CLI is a tool for analyzing and optimizing your JS/TS projects. It helps you identify performance issues, find optimization opportunities, and automatically migrate to suggested dependencies.

> [!IMPORTANT]
> This project is still in early development and we are actively working on it. If you encounter any issues or have ideas for new features, please let us know by [opening an issue](https://github.com/e18e/cli/issues/new/choose) on our GitHub repository.
>

## Quick Start

```sh
// Install and run analysis
npx @e18e/cli analyze

// Migrate packages interactively
npx @e18e/cli migrate --interactive
```

## Installation

You can install the e18e CLI globablly or use it with npx:

```sh
npm install -g @e18e/cli
```

## Learn more

You can learn more about the CLI by going through the [documentation](https://e18e.dev/docs/cli/).

## Contributing

We're happy you'd like to get involved! Please join our [Discord](https://chat.e18e.dev) server to discuss with others.

## License

MIT
MIT License @2025 - Present e18e contributors.
Binary file added public/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading