Skip to content

deep-foundation/deep-export

Repository files navigation

npm Gitpod Discord

Cli utility that allows you to export links from your deep.

Table Of Contents

Library

See Documentation for examples and API

Cli

Cli Usage

deep-export

Options:
  --version         Show version number                                [boolean]
  --url             The url of graphql to export data from   [string] [required]
  --jwt             The JWT token for authentication to the graphql server
                                                             [string] [required]
  --directory-name  The directory name to save data to                  [string]
  --help            Show help                                          [boolean]

Cli Usage Ways

If you are going to use this package in a project - it is recommended to install it is Locally
If you are going to use this package for yourself - it is recommended to install it Globally or run it directly using npx

Directly running using npx

npx --yes deep-export

Global Installation

Global installation and running using binary name

npm install --global deep-export
/home/runner/work/deep-export/deep-export/dist/cli/deep-export

Global installation and running using npx

npm install --global deep-export
npx /home/runner/work/deep-export/deep-export/dist/cli/deep-export

Local installation

Local installation and running using npx

npm install deep-export
npx /home/runner/work/deep-export/deep-export/dist/cli/deep-export

Local installation and running using npm script

npm install deep-export

Add npm script to package.json. Note that you can name your script as you want but it must call binary file provided by the package

{
  "scripts": {
    "/home/runner/work/deep-export/deep-export/dist/cli/deep-export": "/home/runner/work/deep-export/deep-export/dist/cli/deep-export"
  }
}

and run

npm run /home/runner/work/deep-export/deep-export/dist/cli/deep-export