Locofy CLI

Locofy CLI is a command-line tool designed to generate code component bundles for your projects. This README provides comprehensive instructions for installing and using the Locofy CLI.

Details about Locofy Custom components: https://www.locofy.ai/docs/custom-components/overview/

Using Locofy CLI

• Install the Locofy CLI

npm install @locofy/cli -g

• Navigate to the root folder of your codebase

• Create a locofy.config.json to configure your custom components.

locofy init

If you want to use API Custom Domain instead of defaul server. Can use --url: YOUR_URL. E.g:

locofy init --url https://custom-domain.dev

• Push your components from the local codebase to Locofy.

locofy push

Contributing

If you would like to contribute to the development of Locofy CLI, please follow these steps:

1. Fork this repository.
2. Run commands:

npm run install

npm run link

2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request to the main branch of this repository.