@sassoftware/afcli

afcli

afcli is a full node JS commandline for interacting with App Factory Cloud apps, functions, and schemas.

It supports two primary commands:

• create for creating a create-react-app template for a new React UI that integrates with App Factory cloud API.
• sync for generating TypeScript definitions and full interactable hooks for fetching, creating, and using functions and schemas.

Read more about the CLI in our official documentation

afcli commands

Creating new projects with afcli

1. Run the create command in a directory where you want a new Create SAS App project

npx @sassoftware/afcli@latest create

Generate files from an AFC App with afcli

1. Open an App on App Factory Cloud and copy CSA Sync Command

Example:

npx @sassoftware/afcli@latest sync --instance=https://appfactory-<YOUR TEAM>.engage.sas.com --app-id=58 --app-revision=2

1. Paste it in terminal and follow the procedure and provide user ID and password for SAS server

2. Files will be created in folder afcGenerated, by default.

3. Run command without parameters and start the interactive mode

Example:

npx @sassoftware/afcli@latest sync

Local Development

You can setup a local version of the CLI using this repo that updates as code changes are made:

# in the current directory
npm link

Once the link is established, the CLI can be run directly:

afcli --help

To remove the link, you can simply remove it:

On linux: (You may need superuser permission)

rm $(which afcli)

On windows:

# in the repo
npm unlink

Contributions

This project is currently intended for use by participants in the SAS Hackathon. During this event, the repository will refrain from accepting external contributions. However, we have plans to open source the project in the near future, at which point we will welcome contributions from the community.

Please note that after the SAS Hackathon concludes, this notice will be removed, and we will provide updated guidelines for contributing to the project once it becomes open source. We appreciate your understanding and look forward to collaborating with you in the future.