@docusign/cli 1.0.0-rc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -0
- package/dist/index.mjs +720 -0
- package/dist/templates/agreement-manager/README.md +125 -0
- package/dist/templates/agreement-manager/configs/agreement-manager-manifest.json +92 -0
- package/dist/templates/agreement-manager/files/test/MicroLines Employment Offer Letter.docx +0 -0
- package/dist/templates/agreement-manager/files/train/Penny Goodwin Employment Offer Letter.docx +0 -0
- package/dist/templates/agreement-manager/tests/.gitkeep +0 -0
- package/dist/templates/ai-skills/.claude/settings.json +5 -0
- package/dist/templates/ai-skills/.claude/skills/ds-agm-autopilot/SKILL.md +623 -0
- package/dist/templates/ai-skills/.claude/skills/ds-agreement-manager-workflow/SKILL.md +331 -0
- package/dist/templates/ai-skills/.claude/skills/ds-testing/SKILL.md +130 -0
- package/dist/templates/ai-skills/.cursor/rules/docusign.mdc +9 -0
- package/dist/templates/ai-skills/.gemini/instructions.md +9 -0
- package/dist/templates/ai-skills/.github/instructions/docusign.instructions.md +94 -0
- package/package.json +90 -0
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# Workspace Management
|
|
2
|
+
|
|
3
|
+
This project is part of a Docusign CLI workspace. Here are useful commands for managing your workspace:
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
# View all registered workspaces
|
|
7
|
+
docusign workspace list
|
|
8
|
+
|
|
9
|
+
# Show current workspace and project info
|
|
10
|
+
docusign workspace current
|
|
11
|
+
|
|
12
|
+
# Switch to a different workspace
|
|
13
|
+
docusign workspace switch <workspace-name>
|
|
14
|
+
|
|
15
|
+
# Sync workspace from current directory (if .env exists)
|
|
16
|
+
docusign workspace sync
|
|
17
|
+
|
|
18
|
+
# Create another project in this workspace
|
|
19
|
+
docusign scaffold -w <workspace-name> -p <new-project-name>
|
|
20
|
+
|
|
21
|
+
# Remove a workspace from registry (doesn't delete files)
|
|
22
|
+
docusign workspace remove <workspace-name>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Quick Reference
|
|
26
|
+
|
|
27
|
+
| Command | Description |
|
|
28
|
+
| ------------------------------- | ------------------------------- |
|
|
29
|
+
| `docusign scaffold -h` | View scaffold options |
|
|
30
|
+
| `docusign workspace -h` | View workspace commands |
|
|
31
|
+
| `docusign agreement-manager -h` | View agreement-manager commands |
|
|
32
|
+
| `docusign auth -h` | View authentication commands |
|
|
33
|
+
|
|
34
|
+
# Agreement Manager Feature
|
|
35
|
+
|
|
36
|
+
This directory contains the Agreement Manager feature configuration for AI-powered document extraction.
|
|
37
|
+
|
|
38
|
+
## Directory Structure
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
agreement-manager/
|
|
42
|
+
├── configs/
|
|
43
|
+
│ └── agreement-manager-manifest.json # Define agreement types and custom fields
|
|
44
|
+
├── files/
|
|
45
|
+
│ ├── train/ # Training documents for AI extraction
|
|
46
|
+
│ └── test/ # Test documents for validation
|
|
47
|
+
├── tests/ # Test configurations
|
|
48
|
+
└── README.md
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Getting Started
|
|
52
|
+
|
|
53
|
+
### 1. Configure Your Extraction Manifest
|
|
54
|
+
|
|
55
|
+
Edit `configs/agreement-manager-manifest.json` to define:
|
|
56
|
+
|
|
57
|
+
- **standardAgreementTypes**: Pre-built agreement types with standard fields
|
|
58
|
+
- **customAgreementTypes**: Your custom agreement types with specific extraction needs
|
|
59
|
+
- **fields**: Custom fields with AI extraction examples
|
|
60
|
+
|
|
61
|
+
### 2. Add Training Documents
|
|
62
|
+
|
|
63
|
+
Place your training documents in `files/train/`. These documents are used to train the AI extraction model.
|
|
64
|
+
|
|
65
|
+
**Important**: Reference training documents by filename in your manifest's `customAgreementTypes[].docs` array:
|
|
66
|
+
|
|
67
|
+
```json
|
|
68
|
+
{
|
|
69
|
+
"name": "C_SupplierAgreement",
|
|
70
|
+
"customExtractionEnabled": true,
|
|
71
|
+
"docs": ["supplier-agreement-sample1.pdf", "supplier-agreement-sample2.pdf"]
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 3. Add Test Documents
|
|
76
|
+
|
|
77
|
+
Place documents for testing extraction accuracy in `files/test/`. Use these to validate that your trained model extracts data correctly.
|
|
78
|
+
|
|
79
|
+
## Workflow
|
|
80
|
+
|
|
81
|
+
1. **Define** your agreement types and fields in the manifest
|
|
82
|
+
2. **Train** by adding sample documents to `files/train/` and referencing them in the manifest
|
|
83
|
+
3. **Upload** your configuration using `docusign agreement-manager upload`
|
|
84
|
+
4. **Test** extraction accuracy with documents in `files/test/`
|
|
85
|
+
5. **Iterate** by refining examples and retraining as needed
|
|
86
|
+
|
|
87
|
+
## Commands
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
# Validate your manifest configuration
|
|
91
|
+
docusign agreement-manager validate
|
|
92
|
+
|
|
93
|
+
# Upload configuration to Agreement Manager
|
|
94
|
+
docusign agreement-manager upload
|
|
95
|
+
|
|
96
|
+
# Ingest test documents
|
|
97
|
+
docusign agreement-manager ingest --source files/test/
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Tips
|
|
101
|
+
|
|
102
|
+
- Start with 3-5 representative training documents per agreement type
|
|
103
|
+
- Include diverse examples that cover edge cases
|
|
104
|
+
- Use clear, unambiguous field examples in the manifest
|
|
105
|
+
- Test with documents not used in training to measure real accuracy
|
|
106
|
+
|
|
107
|
+
## Note
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
"version": "1.0.0",
|
|
111
|
+
"defaultLocale": "en",
|
|
112
|
+
"namespace": "com.example.manufacturing@1.0.0",
|
|
113
|
+
...
|
|
114
|
+
"metadata": {
|
|
115
|
+
"createdAt": "2025-01-06T00:00:00Z",
|
|
116
|
+
"updatedAt": "2025-01-06T00:00:00Z",
|
|
117
|
+
"version": "1.0.0",
|
|
118
|
+
"author": "Example Team",
|
|
119
|
+
"description": "Example agreement-manager manifest - modify for your use case",
|
|
120
|
+
"tags": ["example", "template"],
|
|
121
|
+
"lastManifestHash": ""
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
These fields are for describing the manifest and for self reference and tracking. These fields are not part of validation or considered in upload to Agreement Manager.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "1.0.0",
|
|
3
|
+
"defaultLocale": "en",
|
|
4
|
+
"namespace": "com.example.manufacturing@1.0.0",
|
|
5
|
+
"standardAgreementTypes": [
|
|
6
|
+
{
|
|
7
|
+
"key": "ConsultingDocumentData",
|
|
8
|
+
"displayName": "Consulting Agreement",
|
|
9
|
+
"fields": {
|
|
10
|
+
"additionalStandardFields": [],
|
|
11
|
+
"customFields": ["Project Code"]
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
],
|
|
15
|
+
"customAgreementTypes": [
|
|
16
|
+
{
|
|
17
|
+
"key": "C_SupplierAgreement",
|
|
18
|
+
"displayName": "Supplier Agreement",
|
|
19
|
+
"description": "Agreement with suppliers for goods and services",
|
|
20
|
+
"category": "BusinessServices",
|
|
21
|
+
"customExtractionEnabled": false,
|
|
22
|
+
"fields": {
|
|
23
|
+
"additionalStandardFields": [],
|
|
24
|
+
"customFields": ["Part Number", "Annual Cost"]
|
|
25
|
+
},
|
|
26
|
+
"docs": []
|
|
27
|
+
}
|
|
28
|
+
],
|
|
29
|
+
"fields": [
|
|
30
|
+
{
|
|
31
|
+
"key": "C_PartNumber",
|
|
32
|
+
"displayName": "Part Number",
|
|
33
|
+
"category": "GeneralCategory",
|
|
34
|
+
"fieldType": "String",
|
|
35
|
+
"customExtractionEnabled": true,
|
|
36
|
+
"aiDefinition": "Manufacturing part number",
|
|
37
|
+
"examples": {
|
|
38
|
+
"en": [
|
|
39
|
+
{
|
|
40
|
+
"exampleText": "Part number is ABC-123",
|
|
41
|
+
"confirmedValue": "ABC-123"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"exampleText": "The component part number: XYZ-789",
|
|
45
|
+
"confirmedValue": "XYZ-789"
|
|
46
|
+
}
|
|
47
|
+
]
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
"key": "C_AnnualCost",
|
|
52
|
+
"displayName": "Annual Cost",
|
|
53
|
+
"category": "FinancialCategory",
|
|
54
|
+
"fieldType": "Number",
|
|
55
|
+
"customExtractionEnabled": true,
|
|
56
|
+
"aiDefinition": "Total annual cost of the agreement",
|
|
57
|
+
"examples": {
|
|
58
|
+
"en": [
|
|
59
|
+
{
|
|
60
|
+
"exampleText": "The annual cost shall be $50,000",
|
|
61
|
+
"confirmedValue": "50000"
|
|
62
|
+
}
|
|
63
|
+
]
|
|
64
|
+
}
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"key": "C_ProjectCode",
|
|
68
|
+
"displayName": "Project Code",
|
|
69
|
+
"category": "GeneralCategory",
|
|
70
|
+
"fieldType": "String",
|
|
71
|
+
"customExtractionEnabled": true,
|
|
72
|
+
"aiDefinition": "Internal project tracking code",
|
|
73
|
+
"examples": {
|
|
74
|
+
"en": [
|
|
75
|
+
{
|
|
76
|
+
"exampleText": "Project code: PROJ-2024-001",
|
|
77
|
+
"confirmedValue": "PROJ-2024-001"
|
|
78
|
+
}
|
|
79
|
+
]
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
],
|
|
83
|
+
"metadata": {
|
|
84
|
+
"createdAt": "2025-01-06T00:00:00Z",
|
|
85
|
+
"updatedAt": "2025-01-06T00:00:00Z",
|
|
86
|
+
"version": "1.0.0",
|
|
87
|
+
"author": "Example Team",
|
|
88
|
+
"description": "Example agreement manager manifest - modify for your use case",
|
|
89
|
+
"tags": ["example", "template"],
|
|
90
|
+
"lastManifestHash": ""
|
|
91
|
+
}
|
|
92
|
+
}
|
|
Binary file
|
package/dist/templates/agreement-manager/files/train/Penny Goodwin Employment Offer Letter.docx
ADDED
|
Binary file
|
|
File without changes
|