README

@appsweet-co/npm-carbon

Copy npm packages and all their versions from one registry to another

➤ Table of Contents

➤ Install
➤ Usage
- Authenticate Using Auth Tokens
- Authenticate Using Username, Password, and Email
➤ Author
➤ 🤝 Contributing
- Working With the @appsweet-co/npm-carbon Repo
  - Install
  - Usage
  - Run Tests
- Submit Your Pull Request
➤ Show your support
➤ 📝 License

Based on goodeggs/npm-copy and dperuo/npm-carbon.

Use this command line tool to make a "carbon copy" of any npm package and all its published versions.

➤ Install

No installation needed. Use @appsweet-co/npm-carbon directly from npm using the npx command.

npx @appsweet-co/npm-carbon <OPTIONS>

➤ Usage

Run --help for a full list of commands.

npx @appsweet-co/npm-carbon --help

Authenticate Using Auth Tokens

npx @appsweet-co/npm-carbon \
  --src ${SRC_URL} \
  --dest ${DEST_URL} \
  --srcToken ${SRC_TOKEN} \
  --destToken ${DEST_TOKEN} \
  packageA [packageB...]

Authenticate Using Username, Password, and Email

npx @appsweet-co/npm-carbon \
  --src ${FROM_URL} \
  --srcUser ${SRC_USERNAME} \
  --srcPassword ${SRC_PASSWORD} \
  --srcEmail ${SRC_EMAIL} \
  --dest ${TO_URL} \
  --destUser ${DEST_USERNAME} \
  --destPassword ${DEST_PASSWORD} \
  --destEmail ${DEST_EMAIL} \
  packageA [packageB...]

Modify Package Prefix

Modify the package prefix using the --from-prefix and --to-prefix flags.

npx @appsweet-co/npm-carbon \
  --srcPrefix ${SRC_PREFIX} \
  --destPrefix ${DEST_PREFIX} \
  packageA [packageB...]

:warning: WARNING: List packages without their prefix when using the prefix flags. Example: @foo/packageA becomes just packageA.

➤ Author

👤 Appsweet.co

Website: http://a6t.co

➤ 🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to check issues page.

Working With the @appsweet-co/npm-carbon Repo

Install

Clone this repo to your local machine and install dependencies.

git clone https://github.com/appsweet-co/npm-carbon.git
cd npm-carbon/
npm install

Usage

Use the start command to compile TypeScript and watch for changes.

npm start

Run the local JavaScript file directly to check your changes.

./bin/index.js <OPTIONS>

Run Tests

Run the full test suite using the test command.

npm run test

Submit Your Pull Request

Always submit your Pull Request against master.

➤ Show your support

Give a ⭐️ if this project helped you!

Usage no npm install needed!