deep-import

Cli utility that allows you to import links into your deep.

Table Of Contents

• Table Of Contents
• Library
• Cli
  • Cli Usage
    • deep-import
  • Cli Usage Ways
    • Directly running using npx
    • Global Installation
      • Global installation and running using binary name
      • Global installation and running using npx
    • Local installation
      • Local installation and running using npx
      • Local installation and running using npm script

Library

See Documentation for examples and API

Cli

Cli Usage

deep-import

Options:
  --version         Show version number                                [boolean]
  --url             The url of graphql to export data from   [string] [required]
  --jwt             The JWT token for authentication in graphql
                                                             [string] [required]
  --directory-name  The directory name to save data to       [string] [required]
  --overwrite       Should overwrite existing links   [boolean] [default: false]
  --debug                                             [boolean] [default: false]
  --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-import

Global Installation

Global installation and running using binary name

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

Global installation and running using npx

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

Local installation

Local installation and running using npx

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

Local installation and running using npm script

npm install deep-import

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-import/deep-import/dist/cli/deep-import": "/home/runner/work/deep-import/deep-import/dist/cli/deep-import"
  }
}

and run

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