{"id":19380359,"url":"https://github.com/atata-framework/atata-cli-npm","last_synced_at":"2025-04-13T23:21:00.106Z","repository":{"id":65393459,"uuid":"379863618","full_name":"atata-framework/atata-cli-npm","owner":"atata-framework","description":".NET library that provides an API for NPM","archived":false,"fork":false,"pushed_at":"2025-01-28T13:27:26.000Z","size":99,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-10T04:26:16.398Z","etag":null,"topics":["api","atata","cli","npm"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atata-framework.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-06-24T08:56:52.000Z","updated_at":"2025-01-28T13:27:29.000Z","dependencies_parsed_at":"2023-01-21T06:45:21.077Z","dependency_job_id":null,"html_url":"https://github.com/atata-framework/atata-cli-npm","commit_stats":{"total_commits":54,"total_committers":1,"mean_commits":54.0,"dds":0.0,"last_synced_commit":"209ce0dae682324ba3cac19e74ab109d0ad1ee76"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":"atata-framework/atata-repository-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-npm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-npm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-npm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-npm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atata-framework","download_url":"https://codeload.github.com/atata-framework/atata-cli-npm/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248794938,"owners_count":21162681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["api","atata","cli","npm"],"created_at":"2024-11-10T09:13:43.821Z","updated_at":"2025-04-13T23:21:00.068Z","avatar_url":"https://github.com/atata-framework.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Atata.Cli.Npm\n\n[![NuGet](http://img.shields.io/nuget/v/Atata.Cli.Npm.svg?style=flat)](https://www.nuget.org/packages/Atata.Cli.Npm/)\n[![GitHub release](https://img.shields.io/github/release/atata-framework/atata-cli-npm.svg)](https://github.com/atata-framework/atata-cli-npm/releases)\n[![Build status](https://dev.azure.com/atata-framework/atata-cli-npm/_apis/build/status/atata-cli-npm-ci?branchName=main)](https://dev.azure.com/atata-framework/atata-cli-npm/_build/latest?definitionId=44\u0026branchName=main)\n[![Slack](https://img.shields.io/badge/join-Slack-green.svg?colorB=4EB898)](https://join.slack.com/t/atata-framework/shared_invite/zt-5j3lyln7-WD1ZtMDzXBhPm0yXLDBzbA)\n[![Atata docs](https://img.shields.io/badge/docs-Atata_Framework-orange.svg)](https://atata.io)\n[![Twitter](https://img.shields.io/badge/follow-@AtataFramework-blue.svg)](https://twitter.com/AtataFramework)\n\n**Atata.Cli.Npm** is a .NET library that provides an API for [NPM](https://www.npmjs.com/).\n\n*The package targets .NET Standard 2.0, which supports .NET 5+, .NET Framework 4.6.1+ and .NET Core/Standard 2.0+.*\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Feedback](#feedback)\n- [SemVer](#semver)\n- [License](#license)\n\n## Features\n\n- Checks whether NPM is installed.\n- Checks whether package is installed.\n- Gets installed package version.\n- Installs package.\n- Uninstalls package.\n\n## Installation\n\nInstall [`Atata.Cli.Npm`](https://www.nuget.org/packages/Atata.Cli.Npm/) NuGet package.\n\n- Package Manager:\n  ```\n  Install-Package Atata.Cli.Npm\n  ```\n\n- .NET CLI:\n  ```\n  dotnet add package Atata.Cli.Npm\n  ```\n\n## Usage\n\nThe main class is `NpmCli` located in `Atata.Cli.Npm` namespace.\n\nThere is also `GlobalNpmPackageCli\u003cTCli\u003e`, which can be used as a base class of specific NPM package CLI.\n\n### Check NPM is Installed\n\n```cs\nbool isNpmInstalled = new NpmCli()\n    .IsItInstalled();\n```\n\n### Ensure NPM is Installed\n\n```cs\nnew NpmCli()\n    .EnsureItIsInstalled();\n```\n\nIf NPM isn't installed, throws `NpmNotFoundException`.\n\n### Install Package Into Directory\n\n```cs\nNpmCli.InDirectory(\"some/dir\")\n    .Install(\"npm-package-name-1\")\n    .Install(\"npm-package-name-2\", \"1.2.3\");\n```\n\n### Install Package Globally\n\n```cs\nnew NpmCli()\n    .Install(\"html-validate\", global: true);\n```\n\n### Install Package If Missing\n\n```cs\nNpmCli.InBaseDirectory()\n    .InstallIfMissing(\"html-validate\", global: true);\n```\n\n### Check Package is Installed\n\n```cs\nbool isPackageInstalled = new NpmCli()\n    .IsInstalled(\"html-validate\", global: true);\n```\n\n### Check Specific Package Version is Installed\n\n```cs\nbool isPackageVersionInstalled = new NpmCli()\n    .IsInstalled(\"html-validate\", \"5.0.0\", global: true);\n```\n\n### Get Installed Package Version\n\n```cs\nstring packageVersion = new NpmCli()\n    .GetInstalledVersion(\"html-validate\", global: true);\n```\n\n### Uninstall Package\n\n```cs\nnew NpmCli()\n    .Uninstall(\"html-validate\", global: true);\n```\n\n## Feedback\n\nAny feedback, issues and feature requests are welcome.\n\nIf you faced an issue please report it to [Atata.Cli.Npm Issues](https://github.com/atata-framework/atata-cli-npm/issues),\n[ask a question on Stack Overflow](https://stackoverflow.com/questions/ask?tags=atata+csharp) using [atata](https://stackoverflow.com/questions/tagged/atata) tag\nor use another [Atata Contact](https://atata.io/contact/) way.\n\n## SemVer\n\nAtata Framework follows [Semantic Versioning 2.0](https://semver.org/).\nThus backward compatibility is followed and updates within the same major version\n(e.g. from 1.3 to 1.4) should not require code changes.\n\n## License\n\nAtata is an open source software, licensed under the Apache License 2.0.\nSee [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatata-framework%2Fatata-cli-npm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatata-framework%2Fatata-cli-npm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatata-framework%2Fatata-cli-npm/lists"}