Skip to content

v7 #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 104 commits into
base: main
Choose a base branch
from
Open

v7 #416

wants to merge 104 commits into from

Conversation

bencmbrook
Copy link
Member

@bencmbrook bencmbrook commented Jul 8, 2025

Reviewer note:
Easiest to review by exploring the code at https://github.com/transcend-io/cli/tree/bencmbrook/v7.

Specifically, comparing the deprecated cli-*.ts commands with the new commands/ directory (where all the code is ported over), and by just testing it:

test via npx or npm i -g

$ npx -p @transcend-io/cli@alpha -- transcend --help         
$ npm install -g @transcend-io/cli@alpha
$ transcend --help
                                                                                                 
USAGE
  transcend request approve|upload|download-files|cancel|restart|notify-additional-time|mark-silent|enricher-restart|reject-unverified-identifiers|export|skip-preflight-jobs|system|preflight|cron ...
  transcend consent build-xdi-sync-endpoint|pull-consent-metrics|pull-consent-preferences|update-consent-manager|upload-consent-preferences|upload-cookies-from-csv|upload-data-flows-from-csv|upload-preferences|consent-manager-service-json-to-yml|consent-managers-to-business-entities ...
  transcend inventory pull|push|scan-packages|discover-silos|pull-datapoints|pull-unstructured-discovery-files|derive-data-silos-from-data-flows|derive-data-silos-from-data-flows-cross-instance ...
  transcend admin generate-api-keys ...
  transcend migration sync-ot ...
  transcend --help
  transcend --version

A command line interface for programmatic operations across Transcend.

FLAGS
  -h --help     Print help information and exit
  -v --version  Print version information and exit

COMMANDS
  request    All commands related to DSR requests
  consent    Consent commands
  inventory  Inventory commands
  admin      Admin commands
  migration  Migration commands
  • Switches to stricli framework which creates self-documenting --help commands and other best practices
  • Modernization
    • Switches to ESM
    • Switches from Yarn PnP to pnpm
    • Switches from Mocha/Chai to vitest
  • Updated readme
    • Exact match to actual args and code
    • Automatically generated
    • readme.ts files in the command file will be inserted as additional documentation
    • Type safety on API scopes

Related Issues

Security Implications

[none]

System Availability

[none]

@bencmbrook bencmbrook marked this pull request as ready for review July 11, 2025 13:48
@bencmbrook bencmbrook requested a review from anotherminh July 11, 2025 13:48
@bencmbrook
Copy link
Member Author

Note on tests:

  • run-mocha is renamed to run-vitest and passing
  • generate-json-schema is renamed to generate and passing
  • CodeQL seems like valid stuff but only popping up bc of touched files; not real changes. Should follow up on a separate PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

--help, and tr-push help don't work
2 participants