Fynd Development Kit

Fynd development Kit (FDK CLI) is a cli tool developed by Fynd to create and update themes, extensions and various other components of the Fynd Platform.

Quick Links

Installation

npm install -g @gofynd/fdk-cli

Basic Commands

To help you get started, there are some basic commands you can use.

fdk --help

To see the available theme commands, enter:

fdk theme

To see the available extension commands, enter:

fdk extension

See the Command overview for a listing of all available commands, or the Command reference for syntax details and usage examples of the commands.

Commands Overview

All FDK CLI commands start with fdk. The general syntax for the commands is as follows:

fdk [module] [method] [options]

This command can be broken down as follows:

Syntax	Example
module	theme
method	init
options	--email email@gmail.com

Commands

Environment Commands

Command	Description
env ls	List environments
env get	Shows current environment
env set	Set active environment to the value provided by the user. Default environment: `fynd`

Authentication Commands

Command	Description
login	Login user
user	Shows user details of logged in user
logout	Logout user

Theme Commands

Command	Description
new	Create new theme
init	Initialize an existing theme
context	Add context of a theme
context-list	List all available contexts
active-context	show currently active context
serve	Start theme serving on localhost
sync	Sync theme to application
pull	Pull latest theme code
pull-config	Pull latest theme config
publish	Publish theme to library
unpublish	Unpublish theme
open	preview theme

Extension Commands

Command	Description
init	Initialize extension
setup	setup development environment
launch-url	Get/set lanuch url

Partner Commands

Command	Description
connect	Add partner access token

Commands Reference

Environment Commands

Before you setup a theme using FDK CLI you will have to set an environment in which you will be initializing your theme

env ls

This command displays a list of all supported environments.

Syntax

fdk env ls

env set

This command sets the active environment to the value provided by the user.

Syntax

fdk env set -n [env-name]

Example

fdk env set -n fynd

Command Options

Option	Description	Required
--name, -n	Environment name	Yes
--help	Show help	No
--verbose, -v	enable debug mode	No

env get

This command displays the active environment set by the user. Default environment: fynd

Syntax

fdk env get

Authentication Commands

After setting the environment the user has to login to the cli. They can use their email ID or phone number to login.

login

This command allows user to login with email or password

Syntax

fdk login

Command Options

Option	Description
--email, -e	Email
--mobile, -m	Mobile
--help	Show help
--verbose, -v	enable debug mode

Example

fdk login -e [your-email]

fdk login -m [your-mobile]

user

This command show user details of the currently logged in user.

Syntax

fdk user

logout

This command will logout the user.

Syntax

fdk logout

Theme Commands

A theme is a VueJS project that developers can scaffold using this cli tool. Themes change the look and feel of websites built using Fynd Platform. Always create a new directory while creating or initializing a theme.

new

This command is used to create a new theme for your application

Syntax

fdk theme new [options]

Command Options

Option	Description
--token, -t	Theme token
--name, -n	Theme name
--help	Show help
--verbose, -v	enable debug mode

You can find the theme token under the themes panel of Fynd Platform. Reference

Example

fdk theme new -t [theme-token] -n [your-theme-name]

init

This command is used to initialize an exisiting theme on your local system.

Syntax

fdk theme init [options]

Command Options

Option	Description
--token, -t	Theme token
--help	Show help
--verbose, -v	enable debug mode

You can find the theme token under the themes panel of Fynd Platform. Reference

Example

fdk theme init -t [your-theme-token]

context

Context is a JSON object which holds the configurations related the the application and theme. When you initialize or create a new theme a context is created with the name provided in the commands and assigned as the active context. You can add multiple contexts if you want to use the same theme on multiple applications or envoirnments.

This command is used to add a new context.

Syntax

fdk theme context [options]

Command Options

Option	Description
--token, -t	Theme token
--name, -n	Context name
--help	Show help
--verbose, -v	enable debug mode

You can find the theme token under the theme panel of Fynd Platform. Reference

Example

fdk theme context -t [your-theme-token] -n [context-name]

context-list

This command is used to get a list of available context. You can also set active context by selecting one of the options in the list

Syntax

fdk theme context-list

active-context

This command is used to get currently active context.

Syntax

fdk theme active-context

serve

This command is used to run a theme on your local system.

Syntax

fdk theme serve [options]

Command Options

Option	Description
--ssr	Enable/disable Server-side rendering
--port	Pass custom port number to serve theme. `Default: 5001`
--help	Show help
--verbose, -v	enable debug mode

By default Server-side rendering is enable. To disable it use --ssr false with the serve command

Example

fdk theme serve

fdk theme serve --port 5002

sync

This command is used to sync your theme to the application.

Syntax

fdk theme sync

Always verify if you have set the correct context before syncing your theme. Refer context commands.

pull

This command is used to pull latest theme code.

Syntax

fdk theme pull

pull-config

This command is used to pull latest theme config.

Syntax

fdk theme pull-config

publish

This command is used to publish your theme.

Syntax

fdk theme publish

unpublish

This command is used to unpublish your theme.

Syntax

fdk theme unpublish

open

This command is used to preview the theme on browser.

Syntax

fdk theme open

Extension Commands

Extensions are pluggable snippets of code that can be installed in your applications so improve the feature set of your application. To know more visit - Fynd Partners

init

This command is used to create a extension's initial code with required dependency. It will also register extension for you on your partner account.

Syntax

fdk extension init [options]

Command Options

Option	Description
--target-dir	Target Directory
--host	Host
--help	Show help
--verbose	enable debug mode

Example

fdk extension init --target-dir [your-directory] --host [your_host]

#### **setup** This command is used to setup extension's development environment in local machine with required dependecies created on [Fynd Partners](https://partners.fynd.com/) panel. #### ****Syntax**** ```sh fdk extension setup [options] ```

Command Options

Option	Description
--target-dir	Target Directory
--host	Host
--help	Show help
--verbose	enable debug mode

Example

fdk extension setup --target-dir [your-directory] --host [your_host]

launch-url

This command is used to get or set the launch url of your extension

Syntax

fdk extension launch-url get/set [options]

Command Options

Option	Description
--url	URL to be set
--api_key	Extension ID
--host	Host
--help	Show help
--verbose	enable debug mode

Set Launch URL Example

fdk extension launch-url set --url [url] --api_key [extension ID] --host [your_host]

Get Launch URL Example

fdk extension launch-url get --api_key [extension id] --host [your_host]

Partner Commands

connect

This command is used to add your partner access token to update extension details on partners panel.

Syntax

fdk partner connect [options]

Command Options

Option	Description
--host	Host
--help	Show help
--verbose, -v	enable debug mode

Example

fdk partner connect --host [your_host]

Log Curl

To print the curl command in the console for all network calls, run the cli commands in debug mode using --verbose flag.

Example

fdk login -e <your_email> --verbose

above command will log the curl command in the console

************** CURL **************
METHOD: POST | PATH: https://api.fynd.com/service/panel/authentication/v1.0/auth/login/password
curl --include --request POST 'https://api.fynd.com/service/panel/authentication/v1.0/auth/login/password' --header 'content-type: application/json' --header 'x-fp-cli: 1.0.144' --header 'x-fp-date: 20230227T174059Z' --header 'x-fp-signature: v1.1:ab4fa30b4f12e2d968110ed809863f6f404621e03eb8a98c8a4fe228c8262684' --header 'x-debug: true' --data-raw '{"username":"email@fynd.com","password":"password@123","g-recaptcha-response":"_skip_"}'
************** END OF CURL **************


User logged in successfully

Other Fynd projects

Project	Link
Nitrozen Vue
Javascript SDK
Extension SDK
Extension Bridge

Contributing

Checkout CONTRIBUTING.md for more information on how to get started contributing to this repository.

Name		Name	Last commit message	Last commit date
Latest commit History 366 Commits
.github/workflows		.github/workflows
.vscode		.vscode
bin		bin
src		src
template		template
.DS_Store		.DS_Store
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc		.prettierrc
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

ManishPrajapati-GoFynd/fdk-cli

Folders and files

Latest commit

History

Repository files navigation

Fynd Development Kit

Quick Links

Installation

Basic Commands

Commands Overview

Commands

Environment Commands

Authentication Commands

Theme Commands

Extension Commands

Partner Commands

Commands Reference

Environment Commands

env ls

Syntax

env set

Syntax

Example

Command Options

env get

Syntax

Authentication Commands

login

Syntax

Command Options

Example

user

Syntax

logout

Syntax

Theme Commands

new

Syntax

Command Options

Example

init

Syntax

Command Options

Example

context

Syntax

Command Options

Example

context-list

Syntax

active-context

Syntax

serve

Syntax

Command Options

Example

sync

Syntax

pull

Syntax

pull-config

Syntax

publish

Syntax

unpublish

Syntax

open

Syntax

Extension Commands

init

Syntax

Command Options

Example

Command Options

Example

launch-url

Syntax

Command Options

Set Launch URL Example

Get Launch URL Example

Packages