Skip to content

formlm/cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

formlm-cli

🚧 Work in progress — not yet published. Stay tuned for the official release.

The official CLI & MCP Server for FormLM — let AI Agents build and manage your forms directly.

npm version License: MIT Node.js

Keywords: FormLM CLI, MCP Server, AI Agent form builder, form automation, assessment platform CLI, Claude MCP, Cursor MCP, AI-powered forms, formlm-cli, npm CLI tool


What is FormLM?

FormLM is an AI-powered form & assessment platform. It lets you build smart forms, scoring quizzes, and professional evaluation reports — all with natural language instructions.

With formlm-cli, you can control FormLM directly from your terminal or plug it into any AI Agent (Claude, Cursor, GPT, etc.) as an MCP Server — no UI needed.

Visit the official website: https://formlm.me


Features

  • Dual-mode: run as a terminal CLI or as an MCP Server for AI Agents
  • 17 built-in tools covering full App / Field / Share lifecycle
  • Multi-profile support — manage multiple accounts or environments
  • Token auth — simple and secure, stored locally with 600 permissions
  • MCP-ready — plug into Claude Desktop, Cursor, or any MCP-compatible client out of the box

Installation

npm install -g @formlm/cli

Requires Node.js ≥ 18.


Quick Start

1. Login

formlm-cli auth login
# or use a token directly
formlm-cli auth login --token <your-token>

You can also get your token from formlm.me: open DevTools → Application → Cookies → copy the Authorization value.

2. Use the CLI

# List all apps
formlm-cli app list

# Create a new app
formlm-cli app create --name "Customer Survey" --description "2024 annual survey"

# Add a field
formlm-cli field add --app <appId> --id q1 --name "Your Name" --type input --required

# Add a radio field with scores
formlm-cli field add --app <appId> --id s1 --type radio --options "Satisfied:3,Neutral:2,Unsatisfied:1"

# Publish the form
formlm-cli share publish --app <appId>

# Get the shareable URL
formlm-cli share url --app <appId>

3. Use as MCP Server

formlm-cli mcp

This starts the MCP Server (stdio transport), ready for AI Agents to connect.


Command Reference

Auth

formlm-cli auth login                 # Interactive login
formlm-cli auth login --token <tok>   # Login with token
formlm-cli auth status                # Check current login state
formlm-cli auth logout                # Clear local token

Profile (multi-account)

formlm-cli profile add --name work --url https://formlm.me --token <tok>
formlm-cli profile list
formlm-cli profile use work           # Switch default profile
formlm-cli --profile work app list    # Use a profile for one command

App

formlm-cli app list
formlm-cli app create --name "My Form" --description "..."
formlm-cli app get --app <appId>
formlm-cli app update --app <appId> --name "New Name" --theme blue
formlm-cli app delete --app <appId>

Field

formlm-cli field schema                                         # All supported field types
formlm-cli field config --type radio                            # Configurable props for a type
formlm-cli field list --app <appId>
formlm-cli field find --app <appId> --id q1                     # Get a single field
formlm-cli field find --app <appId> --filter "name"             # Search fields by keyword
formlm-cli field add --app <appId> --id q1 --name "Name" --type input --required
formlm-cli field add --app <appId> --id n1 --type scale --min 1 --max 10
formlm-cli field update --app <appId> --id q1 --title "Your Full Name"
formlm-cli field remove --app <appId> --id q1
formlm-cli field move --app <appId> --id q1 --pos 3             # Move to position 3

Share

formlm-cli share publish --app <appId>      # Publish (permanent, single submission)
formlm-cli share unpublish --app <appId>    # Unpublish
formlm-cli share query --app <appId>        # Check publish status
formlm-cli share url --app <appId>          # Get the fill-in URL

MCP Integration

Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "formlm": {
      "command": "formlm-cli",
      "args": ["mcp"],
      "env": {
        "FORMLM_BASE_URL": "https://formlm.me",
        "FORMLM_TOKEN": "<your-token>"
      }
    }
  }
}

Cursor / VS Code

Add the same block to .cursor/mcp.json.

Let your AI Agent install it

Paste this into any AI chat:

Help me install FormLM CLI from https://github.com/formlm/cli,
then run: formlm-cli auth login

Available MCP Tools (17)

Category Tool Description
App app_list List all apps
App app_create Create a new app
App app_get Get app details
App app_update Update app name / description / theme
App app_delete Delete an app
Field field_schema List all supported field types
Field field_config Get configurable properties for a field type
Field field_list List all fields in an app
Field field_find Get a single field by ID or keyword
Field field_add Add a new field
Field field_update Update a field
Field field_remove Remove a field
Field field_move Move a field to a specific position
Field field_set_property Fine-grained field property update
Share share_publish Publish the form
Share share_unpublish Unpublish the form
Share share_query Query publish status

Environment Variables

Variable Description
FORMLM_BASE_URL FormLM server URL (default: https://formlm.me)
FORMLM_TOKEN Your auth token (alternative to auth login)

Links


Contact

Have questions, feedback, or need help getting started?

📧 formlm.me@gmail.com

Feel free to reach out — we're happy to help.


License

MIT © FormLM

About

FormLM CLI – Open-source command-line tool for FormLM.me, the AI form builder for teams.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors