{"id":47607683,"url":"https://github.com/microsoft/modernize-cli","last_synced_at":"2026-04-01T19:37:58.991Z","repository":{"id":343619704,"uuid":"1143049656","full_name":"microsoft/modernize-cli","owner":"microsoft","description":"modernize cli releases, tutorials, issues","archived":false,"fork":false,"pushed_at":"2026-03-24T04:19:57.000Z","size":45,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-30T20:34:12.125Z","etag":null,"topics":["cli","copilot","modernize"],"latest_commit_sha":null,"homepage":"https://aka.ms/ghcp-modernization-agent","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-27T05:50:13.000Z","updated_at":"2026-03-24T04:20:01.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/microsoft/modernize-cli","commit_stats":null,"previous_names":["microsoft/modernize-cli"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/microsoft/modernize-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fmodernize-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fmodernize-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fmodernize-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fmodernize-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/modernize-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fmodernize-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31291160,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","copilot","modernize"],"created_at":"2026-04-01T19:37:58.201Z","updated_at":"2026-04-01T19:37:58.969Z","avatar_url":"https://github.com/microsoft.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Copilot modernization CLI\n\n## What is GitHub Copilot modernization CLI?\n\n[GitHub Copilot modernization](https://aka.ms/ghcp-appmod) provides AI-powered capabilities to help users modernize Java and .NET applications easily and confidently.\n\nOrganizations modernizing multiple applications need consistency, repeatability, and the ability to define standards that apply across every dev team and repository. The [GitHub Copilot Modernization Agent](https://aka.ms/ghcp-modernization-agent) is built for these requirements.\n\nDelivered through the Modernize CLI, the modernization agent enables agentic, end-to-end application modernization through intelligent workflow orchestration. It provides architects and app owners with a platform to define modernization standards once - via customizable, reusable skills - and apply them consistently across multiple applications and repositories. It offers a unified CLI and TUI experience for hands-on modernization of individual applications.\n\n## Learn More\n\nFor detailed documentation, tutorials, and additional resources, visit the [GitHub Copilot Modernization Agent documentation](https://aka.ms/ghcp-modernization-agent).\n\n## 🖥️ Supported Platforms\n\n- Windows (x64, ARM64)\n- Linux (x64, ARM64)\n- macOS (Apple Silicon, Intel)\n\n## 🔧 Prerequisites\n\nMinimum requirements:\n- [Git](https://git-scm.com/downloads)\n- [GitHub CLI (gh)](https://cli.github.com/) v2.45.0 or later\n- GitHub Copilot subscription with Free, Pro, Pro+, Business and Enterprise plans, See [Copilot plans](https://github.com/features/copilot/plans?ref_cta=Copilot+plans+signup\u0026ref_loc=install-copilot-cli\u0026ref_page=docs).\n\n## Installation\n\n### Linux / macOS\n\n**Option 1 — Homebrew:**\n```bash\nbrew tap microsoft/modernize https://github.com/microsoft/modernize-cli\nbrew install modernize\n```\n\n**Option 2 — Shell script:**\n```bash\ncurl -fsSL https://raw.githubusercontent.com/microsoft/modernize-cli/main/scripts/install.sh | sh\n```\n\nThe script automatically downloads the latest release, install the modernize bundle to `~/.local/share/modernize`, place the `modernize` command in `~/.local/bin`, and add the command directory to your PATH.\n\nAfter installation, reload your shell profile to apply the PATH update:\n```bash\nsource ~/.bashrc   # or source ~/.zshrc for Zsh\n```\n\n\u003e [!NOTE]\n\u003e **For Linux users:** Requires **glibc 2.27+** (Ubuntu 18.04+, Debian 10+, Fedora 29+, Azure Linux 2.0+).\n\n### Windows\n\n**Option 1 — Winget:**\n```powershell\nwinget install GitHub.Copilot.modernization.agent\n```\n\nFor silent installation (no prompts):\n```powershell\nwinget install GitHub.Copilot.modernization.agent --silent\n```\n\n**Option 2 — PowerShell one-liner:**\n```powershell\niex (irm https://raw.githubusercontent.com/microsoft/modernize-cli/main/scripts/install.ps1)\n```\n\n**Option 3 — MSI installer:**\n\nDownload and run the latest MSI from the [Releases page](https://github.com/microsoft/modernize-cli/releases/latest).\n\nAll three options place the `modernize` command in `%LOCALAPPDATA%\\Programs\\modernize` and add it to your PATH automatically.\n\n\u003e [!NOTE]\n\u003e After installation, open a new terminal for the `modernize` command to be available on your PATH.\n\n---\n\n## Use the interactive mode\n\nThe easiest way to get started is using the interactive mode. First, authenticate with the GitHub CLI:\n\n```bash\ngh auth login\n```\n\nThen, run the modernization agent:\n\n```bash\nmodernize\n```\n\nYou'll be guided through the end-to-end modernization experience via the main menu:\n\n```\n○ How would you like to modernize your Java app?\n\n  \u003e 1. Assess application\n       Analyze the project and identify modernization opportunities\n    2. Create modernization plan\n       Generate a structured plan to guide the agent\n    3. Execute modernization plan\n       Run the tasks defined in the modernization plan\n```\n\n## Commands\n\n### Global options\n\nAll commands support these global options:\n\n| Option | Description |\n|--------|-------------|\n| `--help`, `-h` | Display help information |\n| `--no-tty` | Disable interactive prompts (headless mode) |\n\n### assess\n\nRuns assessment and generates a comprehensive analysis report.\n\n#### Syntax\n\n```bash\nmodernize assess [options]\n```\n\n#### Options\n\n| Option | Description | Default |\n|--------|-------------|---------|\n| `--source \u003cpath\u003e` | Path to source project (relative or absolute local path) | `.` (current directory) |\n| `--output-path \u003cpath\u003e` | Custom output path for assessment results | `.github/modernize/assessment/` |\n| `--issue-url \u003curl\u003e` | GitHub issue URL to update with assessment summary | None |\n| `--multi-repo` | Enable multi-repo assess. Scans first-level subdirectories for multiple repositories | Disabled |\n| `--model \u003cmodel\u003e` | LLM model to use | `claude-sonnet-4.6` |\n| `--delegate \u003cdelegate\u003e` | Execution mode: `local` (this machine) or `cloud` (Cloud Coding Agent) | `local` |\n| `--wait` | Wait for delegated tasks to complete and generate results (only valid with `--delegate cloud`) | Disabled |\n| `--force` | Force restart delegation, ignoring ongoing tasks (only valid with `--delegate cloud`) | Disabled |\n\n#### Examples\n\nBasic assessment of current directory:\n```bash\nmodernize assess\n```\n\nAssess with custom output location:\n```bash\nmodernize assess --output-path ./reports/assessment\n```\n\nAssess and update GitHub issue with results:\n```bash\nmodernize assess --issue-url https://github.com/org/repo/issues/123\n```\n\nAssess specific project directory:\n```bash\nmodernize assess --source /path/to/project\n```\n\nAssess multiple repos in current directory:\n```bash\nmodernize assess --multi-repo\n```\n\n### plan create\n\nCreates a modernization plan based on a natural language prompt describing your modernization goals.\n\n#### Syntax\n\n```bash\nmodernize plan create \u003cprompt\u003e [options]\n```\n\n#### Arguments\n\n| Argument | Description |\n|----------|-------------|\n| `\u003cprompt\u003e` | Natural language description of modernization goals (required) |\n\n#### Options\n\n| Option | Description | Default |\n|--------|-------------|---------|\n| `--source \u003cpath\u003e` | Path to the application source code | Current directory |\n| `--plan-name \u003cname\u003e` | Name for the modernization plan | `modernization-plan` |\n| `--language \u003clang\u003e` | Programming language (`java` or `dotnet`) | Auto-detected |\n| `--overwrite` | Overwrite an existing plan with the same name | Disabled |\n| `--model \u003cmodel\u003e` | LLM model to use | `claude-sonnet-4.6` |\n\n#### Examples\n\nGenerate a migration plan:\n```bash\nmodernize plan create \"migrate from oracle to azure postgresql\"\n```\n\nGenerate an upgrade plan with custom name:\n```bash\nmodernize plan create \"upgrade to spring boot 3\" --plan-name spring-boot-upgrade\n```\n\nGenerate a deployment plan:\n```bash\nmodernize plan create \"deploy the app to azure container apps\" --plan-name deploy-to-aca\n```\n\n### plan execute\n\nExecutes a modernization plan created by `modernize plan create`.\n\n#### Syntax\n\n```bash\nmodernize plan execute [prompt] [options]\n```\n\n#### Arguments\n\n| Argument | Description |\n|----------|-------------|\n| `[prompt]` | Optional natural language instructions for execution (e.g., \"skip tests\") |\n\n#### Options\n\n| Option | Description | Default |\n|--------|-------------|---------|\n| `--source \u003cpath\u003e` | Path to the application source code | Current directory |\n| `--plan-name \u003cname\u003e` | Name of the plan to execute | `modernization-plan` |\n| `--language \u003clang\u003e` | Programming language (`java` or `dotnet`) | Auto-detected |\n| `--model \u003cmodel\u003e` | LLM model to use | `claude-sonnet-4.6` |\n| `--delegate \u003cdelegate\u003e` | Execution mode: `local` (this machine) or `cloud` (Cloud Coding Agent) | `local` |\n| `--force` | Force execution even when a CCA job is in progress | Disabled |\n\n#### Examples\n\nExecute the most recent plan interactively:\n```bash\nmodernize plan execute\n```\n\nExecute a specific plan:\n```bash\nmodernize plan execute --plan-name spring-boot-upgrade\n```\n\nExecute with additional instructions:\n```bash\nmodernize plan execute \"skip the test\" --plan-name spring-boot-upgrade\n```\n\nExecute in headless mode for CI/CD:\n```bash\nmodernize plan execute --plan-name spring-boot-upgrade --no-tty\n```\n\n### upgrade\n\nRuns an end-to-end upgrade workflow — plan, and execute — in a single command.\n\n#### Syntax\n\n```bash\nmodernize upgrade [\u003cprompt\u003e] [options]\n```\n\n#### Arguments\n\n| Argument | Description |\n|----------|-------------|\n| `[\u003cprompt\u003e]` | Target version (e.g., `Java 17`, `Spring Boot 3.2`, `.NET 10`). Defaults to latest LTS. |\n\n#### Options\n\n| Option | Description | Default |\n|--------|-------------|---------|\n| `--source \u003csource\u003e` | Path to source project (relative or absolute local path) | `.` (current directory) |\n| `--delegate \u003cdelegate\u003e` | Execution mode: `local` (this machine) or `cloud` (Cloud Coding Agent) | `local` |\n| `--model \u003cmodel\u003e` | LLM model to use | `claude-sonnet-4.6` |\n\n#### Examples\n\nRun upgrade on current directory:\n```bash\nmodernize upgrade \"Java 17\"\n```\n\n```bash\nmodernize upgrade \".NET 10\"\n```\n\nRun upgrade on a specific project:\n```bash\nmodernize upgrade \"Java 17\" --source /path/to/project\n```\n\nRun upgrade using the Cloud Coding Agent:\n```bash\nmodernize upgrade \"Java 17\" --delegate cloud\n```\n\n### help\n\nProvides help and information commands.\n\n#### Syntax\n\n```bash\nmodernize help [command]\n```\n\n#### Commands\n\n| Command | Description |\n|---------|-------------|\n| `models` | List available LLM models and their multipliers |\n\n#### Examples\n\nList available models:\n```bash\nmodernize help models\n```\n\n### Environment variables\n\n| Variable | Description | Default |\n|----------|-------------|---------|\n| `MODERNIZE_COLLECT_TELEMETRY` | Enable/disable telemetry collection | `true` |\n| `MODERNIZE_LOG_LEVEL` | Logging level (debug, info, warn, error) | `info` |\n\nExample:\n```bash\nexport MODERNIZE_COLLECT_TELEMETRY=false\nmodernize assess\n```\n\n## Feedback\n\nWe're thrilled to have you join us on the early journey of the modernization agent. Your feedback is invaluable—please [share your thoughts](https://aka.ms/ghcp-appmod/feedback) with us!\n\n## Disclaimer\n\nUnless otherwise permitted under applicable license(s), users may not decompile, modify, repackage, or redistribute any assets, prompts, or internal tools provided as part of this product without prior written consent from Microsoft.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fmodernize-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fmodernize-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fmodernize-cli/lists"}