Skip to content

chore: Update README #1617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 18, 2025
Merged

chore: Update README #1617

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6647225
chore: Update README
mohab-sameh Jul 16, 2025
d5223f0
chore(readme): update badges
mohab-sameh Jul 17, 2025
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
60 changes: 18 additions & 42 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,59 +16,35 @@
</p>
</p>

## Codemod
# Codemod

Codemod platform helps you create, distribute, and run codemods in codebases of any size.
[![Docs](https://img.shields.io/badge/docs-available-brightgreen)](https://docs.codemod.com)
[![Community](https://img.shields.io/badge/slack-join-blue)](https://codemod.com/community)
[![License](https://img.shields.io/github/license/codemod-com/codemod)](LICENSE)

The AI-powered, community-led codemods enable you to automate framework upgrades, large refactoring, and boilerplate programming with unparalleled speed and developer experience.
Codemod is the AI-powered, community-led platform for automating code migrations, framework upgrades, and large-scale changes.

We are making dream migrations a reality for all developers in the world, one framework at a time.
## Get Started

## Documentation
- **Platform:** [Codemod Platform](https://go.codemod.com/app) — Plan, automate, and track migrations in any codebase.
- **Docs:** [docs.codemod.com](https://docs.codemod.com)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add new registry link

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new registry is still shadow-published. @mohebifar You still don't want to make it the default one yet, correct?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new registry is still shadow-published

Yeah but codemod you write on studio is disigned to be publish on the new registry so that make sense to allow user to see it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a bit of a transitional phase we're in. The new registry in its current state cannot replace the legacy one yet. That would even have significant negative SEO impact. However, it's important this phase doesn't last for long and all existing codemods are transferred to the new registry. cc @mohebifar @alexbit-codemod


For details on how to use Codemod, check out our [documentation](https://go.codemod.com/docs).
## Platform Features

## Codemod Platform
Codemod helps you plan, automate, and orchestrate code migrations at scale. Here’s what you can do:

Codemod platform helps you plan, automate, orchestrate, and track code migrations in codebases of any size.
- **Migrations:** Automate code changes and framework upgrades with AI-powered codemods. [Learn more](https://docs.codemod.com/migrations)
- **Insights:** Track, measure, and report on migration progress and code health. [Learn more](https://docs.codemod.com/insights)
- **Codemod Studio:** Author, test, and share codemods using an intuitive web interface. [Learn more](https://docs.codemod.com/codemod-studio)
- **Workflows:** Orchestrate and manage large-scale code migration campaigns. [Learn more](https://docs.codemod.com/platform/workflows)
- **CLI:** Run codemods and manage migrations from your terminal. [Learn more](https://docs.codemod.com/cli/cli-reference)

To get started, go to [Codemod platform](https://go.codemod.com/app).
## CLI

## Codemod CLI
> The new Codemod CLI is under active development. For the latest features and usage, see our [CLI docs](https://docs.codemod.com/cli/cli-reference).

### Quickstart

To get started, you can install Codemod CLI:

```
npm i -g codemod
```

With Codemod CLI, you can:

#### 1. Build codemods

You can easily scaffold and start building codemods by running the following command:

```
codemod init
```

#### 2. Publish codemods

You can publish a [compatible](https://go.codemod.com/package-structure) local codemod package to [Codemod Registry](https://codemod.com/registry) with:

```
codemod publish
```

#### 3. Run codemods

```
codemod [codemod name]
```

## Community
## Community & Support

Codemod community can be found on [Slack](https://codemod.com/community), where you can ask questions, share your feedback, and contribute to the community.

Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy