Hycode

Homepage: hycode.io

Description

Hycode's NPM package enables developers to seamlessly pull code from their Hycode vault directly into their code editor.

Developers have complete control when deciding what to pull from their vault, even if their code has multiple versions and/or other snippet dependencies.

With easy-to-use commands and a flexible configuration, our package empowers developers to focus on writing code rather than searching for, and managing code snippets.

Installation

To install the package, run:

npm install hycode
or
npm i hycode

Setup Config

Once the package has been installed you must run hycode init to generate the required configuration file.

After hycode-config.js is created you can manage the following settings:

module.exports = {
  organiseByTab: true,
  importFileType: ".tsx",
};

When organiseByTab is true, any snippets pulled from your vault will be added into a directory based on what tab group they are saved under in Hycode.

For example, if you have a snippet called 'Text Input' saved in the tab group 'Elements', the file will be created at: /src/components/hycode/elements/TextInput.tsx

importFileType allows you to specify what file type you want to import your snippets as. By default it is set to .tsx.

Connect Your Hycode Account

With the package installed and hycode-config.js present, you can now log into your Hycode account by simply running hycode login and entering the email and password associated with your Hycode account.

Pulling Your Code

There are a few options when pulling your code.

hycode pull: List and pull all snippets from your individual vault.

hycode pull <snippetName>: Pull a specific snippet by name.

hycode pull <snippetName> <versionNumber>: Pull a specific snippet by name and version number.

hycode pull <teamName>: List and pull all snippets from your specified team vault.

hycode pull <teamName> <snippetName>: Pull a specific team snippet by name.

hycode pull <teamName> <snippetName> <versionNumber>: Pull a specific team snippet by name and version number.

Other Commands

hycode login: Log in via Hycode email and password.

hycode logout: Log out of account.

hycode user: Check currently logged account.

hycode init: Generate Hycode configuration file.

Recommended Usage

We recommened reading our breif documentation for how to get the most out of Hycode and our NPM package.

www.hycode.io/docs