A CLI to download and upload serialized representations of full ordercloud marketplaces.
For node.js users, install with npm i @ordercloud/seeding -g
and then run seeding --help
.
npx @ordercloud/seeding --help
.For docker users docker run --mount type=bind,source=<local directory>,target=/app oliverheywood/ordercloud-seeding --help
.
<local directory>
for an absolute path in order for local file reading and writing to be mounted on the container. Download an executable. Run like ./seeding-win.exe --help
.
Operating System | Executable |
---|---|
Windows | seeding-win.exe |
Mac | seeding-macos |
Linux | seeding-linux |
Create a marketplace from a "Simple-B2C" template.
npx @ordercloud/seeding seed Simple-B2C -u={username} -p={password}
Create a marketplace based on data in a local file. Looks for files based on the directory the command is run from.
npx @ordercloud/seeding seed seed-data-file.yml -u={username} -p={password}
Create a marketplace based on a public url.
npx @ordercloud/seeding seed https://raw.githubusercontent.com/ordercloud-api/ordercloud-seed/main/seeds/Simple-B2C.yml -u={username} -p={password}
Download the data from an existing marketplace to a seed file.
npx @ordercloud/seeding download new-file-to-create.yml -i={existing-marketplace-id} -u={username} -p={password}
Validate that a local file would seed successfully.
npx @ordercloud/seeding validate my-file.yml
import { download, seed, validate, SerializedMarketplace } from "@ordercloud/seeding";
var myData: SerializedMarketplace = { ... };
await seed({
portalJWT: "xxxxxx",
rawData: myData,
logger: (message:string, type: MessageType) => {
console.log(message)
}
});
These are seeding files maintained as part of this repo that represent templates for common ordercloud use cases.
Command Alias | Raw URL |
---|---|
seed Simple-B2C |
https://raw.githubusercontent.com/ordercloud-api/ordercloud-seed/main/seeds/Simple-B2C.yml |
npm install
npm run build
everytime you change source files.node ./dist/cli.js [command]
to debug a command.npm run test
to run unit tests.Note: You must have node version 16 to build the package, you will get errors on node v17 and higher
npm run build
to build the codenpm run test
to run the unit tests against your built codenpm run pkg
to generate the executables (The following warning can be safely ignored: Warning Cannot resolve 'config.)npm publish