@linktr.ee/create-link-app

CLI tool to create Link Apps on Linktr.ee.

Public document

Getting Started

(Optional) Install create-link-app globally

yarn global add @linktr.ee/create-link-app
# or
npm install -g @linktr.ee/create-link-app

which create-link-app

create-link-app --help

Or run with npx

npx @linktr.ee/create-link-app --help

Commands

• create-link-app build
• create-link-app create NAME
• create-link-app deploy
• create-link-app dev
• create-link-app grant-access LINK_APP_ID USERNAME
• create-link-app help [COMMAND]
• create-link-app login
• create-link-app logout
• create-link-app storybook
• create-link-app test-url-match-rules URL

create-link-app build

Build Link App project to static assets used for production

USAGE
  $ create-link-app build [--native] [--profile]

FLAGS
  --native   Build native components of a Link App ready for publishing to npm
  --profile  Enable detailed webpack profiling and bundle analysis

DESCRIPTION
  Build Link App project to static assets used for production

create-link-app create NAME

Initialize a new Link App project

USAGE
  $ create-link-app create NAME [-p <value>] [--storybook]

ARGUMENTS
  NAME  Name of the Link App

FLAGS
  -p, --path=<value>  Path to create the project in
  --storybook         With Storybook added to the project

DESCRIPTION
  Initialize a new Link App project

EXAMPLES
  $ create-link-app create my-link-app

  $ create-link-app create my-link-app --path my/custom/path

  $ create-link-app create my-link-app --storybook

create-link-app deploy

Deploy your Link App and test it on Linktr.ee

USAGE
  $ create-link-app deploy [-p <value>] [--update]

FLAGS
  -p, --path=<value>  Specify custom path to project directory
  --update            [Deprecated]

DESCRIPTION
  Deploy your Link App and test it on Linktr.ee

create-link-app dev

Start development server for Link App project

USAGE
  $ create-link-app dev [-p <value>] [--host <value>] [--https] [--allowedHosts <value>]

FLAGS
  -p, --port=<value>      [default: 3000] Development server listening port
  --allowedHosts=<value>  [default: all] Allowed hosts for development server. You can set a single host or use "all" to
                          allow all hosts
  --host=<value>          [default: localhost] Hostname
  --https                 Use HTTPS for development server

DESCRIPTION
  Start development server for Link App project

EXAMPLES
  $ create-link-app dev

  $ create-link-app dev --port 8000

  $ create-link-app dev --https

create-link-app grant-access LINK_APP_ID USERNAME

Grant access to other developers to push updates for your Link App

USAGE
  $ create-link-app grant-access LINK_APP_ID USERNAME

ARGUMENTS
  LINK_APP_ID  The Link App's ID you wish to grant access to
  USERNAME     The Linktree username of the developer you wish to grant access to

DESCRIPTION
  Grant access to other developers to push updates for your Link App

EXAMPLES
  $ create-link-app grant-access my-link-app friend

create-link-app help [COMMAND]

Display help for create-link-app.

USAGE
  $ create-link-app help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for create-link-app.

See code: @oclif/plugin-help

create-link-app login

Login using your Linktree credentials to deploy Link Apps

USAGE
  $ create-link-app login

DESCRIPTION
  Login using your Linktree credentials to deploy Link Apps

create-link-app logout

Logout and clear browser session

USAGE
  $ create-link-app logout

DESCRIPTION
  Logout and clear browser session

create-link-app storybook

Start the Storybook development server

USAGE
  $ create-link-app storybook [-p <value>]

FLAGS
  -p, --port=<value>  [default: 6006] Port to run the Storybook server on

DESCRIPTION
  Start the Storybook development server

create-link-app test-url-match-rules URL

Test URL match rules

USAGE
  $ create-link-app test-url-match-rules URL

ARGUMENTS
  URL  URL to test

DESCRIPTION
  Test URL match rules

EXAMPLES
  $ create-link-app test-url-match-rules https://linktr.ee/linktree