@docusign/cli 1.2.0-rc → 1.3.0-rc

package/dist/templates/package/README.md

@@ -14,6 +14,88 @@ This directory contains files for managing DocuSign packages in this project.
 ds package create --name=my-package
 ```
 
+### Add components to a package
+
+Each component is given as `<id>:<name>`. Quote names that contain spaces.
+
+```bash
+ds package add --name=my-package --esign-templates "555:NDA" "775:MSA"
+ds package add --name=my-package --workflow "111:Invoice approval" --webform "9f2:Intake form"
+```
+
+| Flag                | Component type      |
+| ------------------- | ------------------- |
+| `--esign-templates` | eSignature template |
+| `--templates`       | Document template   |
+| `--workflow`        | Maestro workflow    |
+| `--webform`         | Web form            |
+
+List several components after one flag or repeat the flag; different types can be combined in one call. Use `--id=<packageId>` instead of `--name` to pick one package when names are shared.
+
+### Remove components
+
+```bash
+ds package remove --name=my-package --esign-templates "775:MSA"
+```
+
+To change a component, remove it and add it again.
+
+### See what a package contains and where it stands
+
+```bash
+ds package view-details --name=my-package
+ds package status --name=my-package
+```
+
+`status` reports Processing while an import, export or publish is running, Installed once the package has been installed, otherwise the package's own status (Draft, Published, Archived or Review).
+
+### Export a package
+
+```bash
+ds package export --name=my-package
+ds package export --name=my-package --output=./backups/my-package.zip
+```
+
+The zip is saved in this project's `package/files` folder as `<package name>-<first 8 characters of the id>.zip`, unless you pass `--output`. Exporting publishes the package first, and a Published package cannot take new components. The CLI refuses to export a package with no components, since the zip would be empty.
+
+### Install a package in another account
+
+A private package cannot be installed by id from another account. Export it, log in to the target account, and install the zip.
+
+```bash
+ds package export --name=my-package                      # in the source account
+ds auth login                                            # choose the target account
+ds package install --file my-package-1a2b3c4d.zip --prefix "copy-"
+```
+
+A bare file name is also looked up in this project's `package/files` folder. `--prefix` puts text in front of the name of every component the install creates; use it for test installs, because the CLI cannot remove installed components.
+
+You can also install a package that is already on the server, from your account or a public one:
+
+```bash
+ds package install --name=my-package
+ds package install --id=<packageId> --source public
+```
+
+The install runs on the server and the CLI follows it. It can stop twice to ask for something:
+
+- **Connections.** An app in the package needs a connection in this account. Pick one you already have, or connect a new one: the CLI opens the app's sign-in page and waits until the connection is active.
+- **Consent.** Workflows must be consented to before they are published. The CLI opens the consent page. Use `--draft-workflows` to create the workflows as drafts and skip this step.
+
+| Flag                 | What it does                                                              |
+| -------------------- | ------------------------------------------------------------------------- |
+| `--file <zip>`       | Install from a zip file                                                   |
+| `--prefix <text>`    | Put `<text>` in front of the name of every component the install creates  |
+| `--update`           | Overwrite components that already exist in this account                   |
+| `--draft-workflows`  | Create workflows as drafts instead of publishing them                     |
+| `--connection a=c`   | Use connection `c` for app `a`, so the install does not stop to ask       |
+| `--no-browser`       | Print links instead of opening them                                       |
+| `-y`                 | Do not ask for confirmation (needed without a terminal)                   |
+| `--resume [--event]` | Continue an install that stopped, for example because the terminal closed |
+| `--cancel [--event]` | Stop an install that is waiting for you; what it already created stays    |
+
+If the terminal closes, the install keeps running. Run `ds package install --resume` to pick it up again. Run `ds package install -h` for exit codes, what to do when an install fails, and how it behaves without a terminal.
+
 ### Get help
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusign/cli",
-  "version": "1.2.0-rc",
+  "version": "1.3.0-rc",
   "author": "Docusign",
   "description": "The Docusign CLI simplifies the implementation of Docusign Agreement Manager. With this CLI, you can bulk configure Agreement Manager with custom fields and types, map fields to types, provide AI training sets for custom extractions, programmatically test extraction accuracy, and export/import your setup across accounts. This offering is currently in beta.",
   "main": "dist/index.mjs",

package/dist/templates/packages/README.md

@@ -1,59 +0,0 @@
-# Packages Feature
-
-This directory contains the Packages feature for managing and distributing packages.
-
-## Directory Structure
-
-```
-packages/
-├── configs/             # Package configuration files
-├── files/
-│   ├── train/          # Training/example package files
-│   └── test/           # Test package files
-├── tests/              # Package tests and validation scripts
-└── README.md
-```
-
-## Getting Started
-
-### 1. Configure Your Packages
-
-Create package configuration files in `configs/`. These define:
-
-- Package metadata (name, version, description)
-- Package dependencies
-- Package contents and structure
-- Distribution settings
-
-### 2. Add Package Files
-
-Organize your package files in `files/`:
-
-- **files/train/**: Example or template package files
-- **files/test/**: Test packages for validation
-
-### 3. Define Tests
-
-Add test scripts and validation rules to `tests/` to ensure package quality and correctness.
-
-## Workflow
-
-1. **Create** package configurations in `configs/`
-2. **Organize** package files in `files/`
-3. **Define** validation tests in `tests/`
-4. **Validate** packages using the appropriate commands
-5. **Distribute** packages as needed
-
-## Tips
-
-- Keep package configurations modular and reusable
-- Use semantic versioning for package versions
-- Include clear documentation in package metadata
-- Test packages thoroughly before distribution
-- Version control your configurations for tracking changes
-
-## Next Steps
-
-- Configure your first package in `configs/`
-- Add example files to `files/train/`
-- Create validation tests in `tests/`