To use fdk cli command the user has to login to the cli.

This command allows user to login via partner panel.

fdk login [options]

fdk login

fdk login --host partners.fynd.com

fdk login --host api.fynd.com

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

fdk user

This command will logout the user.

fdk logout

Using this command populate sample data into development account to get started with theme and extension development.

fdk populate

This command will start a tunnel using cloudflare by which you can access your local port on public url

fdk tunnel [options]

fdk tunnel --port 8080

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.

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

fdk theme new [options]

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

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

fdk theme init [options]

fdk theme init

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.

fdk theme context [options]

fdk theme context -n [context-name]

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

fdk theme context-list

This command is used to get currently active context.

fdk theme active-context

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

fdk theme serve [options]

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

fdk theme serve

fdk theme serve --port 5002

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

fdk theme sync

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

This command is used to pull latest theme code.

fdk theme pull

This command is used to pull latest theme config.

fdk theme pull-config

This command is used to create a zip file of theme.

fdk theme package

This command is used to preview the theme on browser.

fdk theme open

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

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.

• You must have installed Git, if you don't already have it.

fdk extension init [options]

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

fdk extension init --template [template-name]

You can pass the following values for the template:

1. node-vue
2. node-react
3. java-vue
4. java-react

This command will return the preview URL, which the user can use to launch or install the extension.

fdk extension preview [options]

fdk extension preview

fdk extension preview --tunnel-url https://broke-casey-eric-recommendations.trycloudflare.com

fdk extension preview --company-id 999

• Cloudflared will be used as the tunneling tool.

• If you pass Tunnel URL, it will not created new tunnel and use the passed url as tunnel url.

This command will fetch extension context details from partners panel and update current extension context.

fdk extension pull-env

fdk extension pull-env

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

fdk extension launch-url get/set [options]

fdk extension launch-url set --url [url] --api-key [Extension API Key]

fdk extension launch-url get --api-key [Extension API Key]

Extensions bindings are reusable components which are pluggable through the theme editor to improve the user interface of your application. These can be used just like theme sections.

Set the active environment before running extension commands

fdk env set -u api.fynd.com

This command is used to create a basic boilerplate code for extension binding with required dependencies.

fdk binding init [options]

fdk binding init

This command is used to register the binding with your development companies for alpha or beta testing.

fdk binding draft [options]

fdk binding draft

This command is used to publish the binding across all live companies.

fdk binding publish [options]

fdk binding publish

This command will allow developers to locally serve the extension binding which has been added to a live storefront.

fdk binding preview [options]

fdk binding preview

This command will allow developers to see the current extension section context.

fdk binding show-context

This command will allow developers to clear the current extension section context.

fdk binding clear-context

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

fdk partner connect [options]

fdk partner connect

The set commands allow you to configure the cafile and strict-ssl settings for the tool. This is useful for ensuring that the tool uses the correct SSL certificates and validation settings according to your requirements.

fdk config set cafile /etc/ssl/certs/ca-certificates.pem

fdk config set strict-ssl false

• Ensure that the file path provided for the CA file is valid and accessible.
• The strict SSL setting should be either true or false.

Developers can configure settings using environment variables.

---

FDK_EXTRA_CA_CERTS: Set this variable to specify the CA file path (cafile).

---

FDK_SSL_NO_VERIFY: Set this variable to true to disable strict SSL validation (strict-ssl=false).

---

FDK_EXTRA_CA_CERTS=/path/to/your/cafile fdk login

FDK_SSL_NO_VERIFY=true fdk login

The get commands allow you to view the current configuration values for cafile and strict-ssl. This is useful for verifying what values are currently set and ensuring that your configuration is correct.

fdk config get cafile

fdk config get strict-ssl

The delete commands allow you to remove the current configuration for cafile and strict-ssl. This can be useful for resetting configurations or removing settings that are no longer needed.

fdk config delete cafile

fdk config delete strict-ssl

fdk config rm cafile

When attempting to start a Cloudflare tunnel using the fdk tunnel or fdk ext preview commands, users on Apple Silicon machines may encounter difficulties due to the Cloudflare binary's compatibility requirements.

Solution: Install Rosetta, which allows you to run applications that contain x86_64 instructions on Apple Silicon. You can do this by executing the following command in your terminal:

softwareupdate --install-rosetta

This command prompts your system to install Rosetta, resolving the compatibility issue and allowing the Cloudflare tunnel to run smoothly on your machine.

Project	Link
Nitrozen Vue
Javascript SDK
Extension SDK
Extension Bridge

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