Member site CLI

​

Install and sign in

npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-member-site

​

Choose the login

• Admins and reps sign in with fluid login.
• A member signs in to these commands with the member’s own token, set in FLUID_TOKEN. fluid login doesn’t sign members in. See Credentials for what counts as a member’s token.
• A member who is also an admin of the same company is refused by the member API, so that login builds company sites only.

​

Set the API base

export FLUID_API_BASE=https://api.fluid.app
export FLUID_TOKEN=<member token>
fluid member-site list --as member

​

Build a site

fluid member-site create rileys-shop --name "Riley's Shop" --as member

fluid member-site pull rileys-shop --as member
cd rileys-shop

fluid member-site lint

fluid member-site dev

fluid member-site push --dry-run
fluid member-site push --publish

​

Commands

​

list

fluid member-site list
fluid member-site list --as member

​

create

fluid member-site create rileys-shop --name "Riley's Shop"
fluid member-site create fall-launch --company --as admin

​

pull

fluid member-site pull rileys-shop --as member
fluid member-site pull fall-launch ./site --as admin

• A pull is all or nothing. It reads every file before it writes any, so a failed read leaves the folder as it was. A file already identical on disk is left alone.
• It refuses to overwrite your work. A folder that isn’t empty and isn’t bound to this site is refused, and so is a pull that would overwrite a file you edited since the last pull. --force writes anyway.
• It never deletes your files. A file that isn’t on the server is kept. The one exception is config/access.json: when the site no longer has one and your copy is unchanged since the last pull or push, the pull deletes it, so the next push doesn’t bring back a declaration another writer removed. An edited copy is kept unless you pass --force.
• It doesn’t write through symbolic links. A file or folder of the site that is, or is inside, a link is refused before any file is written, with or without --force.
• A member’s site can’t be pulled with an admin login. With --as admin, or in a folder bound to a member’s site, the command stops before any request and names the login the site needs.

​

push

fluid member-site push --dry-run
fluid member-site push --as member
fluid member-site push --publish

1. config/settings.json.
2. Each changed or new layout, section, snippet and asset, and config/access.json, in path order. On a company site the push leaves config/access.json alone and says so, because the server refuses the path.
3. Each new page with its file’s content, then each changed page with its changed row fields and content.
4. config/menus.json, when it changed. It replaces every menu of the site.
5. Each page’s menu assignment.
6. Each removed page, then each removed layout, section, snippet, asset and config/access.json. Removals go last, so a failed write never leaves a menu pointing at a page that is gone.

• A file that isn’t a text asset. An asset must be css, js, json, txt or html, valid UTF-8 and not empty.
• A path outside layouts, sections, snippets, pages, assets and config, a path in a subfolder, a symbolic link, and a name outside lowercase letters, digits, hyphens and underscores. A page’s name is lowercase letters and digits separated by single hyphens. Names that start with a dot are ignored.
• A page file with no row in config/pages.json, a new row with no file, and a row or file removed without the other. A page goes with its file, so remove both or neither.
• A config/access.json that isn’t a valid declaration.
• A config/pages.json that isn’t valid, a page slug of index, a menu that config/menus.json doesn’t define, settings that aren’t a JSON object, and menus that don’t have the shape the API takes.
• New pages that don’t fit in the site’s 50-page limit. This check needs the site’s current page count, so --dry-run, which sends no request, skips it and says so.
• A menu link whose url isn’t a well-formed http or https address with a host. A space or non-ASCII character in the address is refused rather than corrected.
• A file the binding holds no version for, which happens after a pull from before the API reported versions. Pull the site again first.

​

publish

fluid member-site publish
fluid member-site publish ./rileys-shop --as member

• A taken-down site can’t be published. The command prints the API’s message, exits with a non-zero code and doesn’t retry.
• A 409 means the site changed while it was being published. The site wasn’t published. Run the command again.
• A publish moves versions. It changes the version of every page, layout, section and snippet it publishes, and of the settings. After it succeeds, the CLI records the new versions in the binding only when it can prove the publish published what the folder holds. Anything else keeps its old version, and the next push stops on it and asks for a pull. Push a file you edited before you publish it.

​

lint

fluid member-site lint
fluid member-site lint ./rileys-shop

• Liquid in layouts, sections, snippets and pages, with the same messages as fluid theme lint: the {% schema %} block and the pairing of block tags such as {% if %} and {% endif %}. The theme linter’s cart, missing-section and routed-template checks are theme rules and don’t run.
• The file rules a push enforces, with the same messages.
• config/pages.json, which must be valid and list at most 50 pages. A page with no file still counts.
• config/menus.json, which must have the shape the API takes. Each link that names a page must name a page that config/pages.json lists.
• config/access.json, which must be a file the API accepts. Each problem is an error.
• Viewer data. Lint warns on a Liquid file that reads member.<field>. When the declaration is valid, it also checks each fluid.fetch(path, { method }) call in a script against the scope of that path. It warns when the declaration lacks the scope, when no site can ever reach the route, and when it can’t read the call, for example because the path or method comes from a variable. See Declare what a member site uses.

​

dev

fluid member-site dev
fluid member-site dev ./rileys-shop --as member --port 9600
fluid member-site dev --allow-production

• It won’t write production unless you say so. A session saves the folder when it starts and again on every change, and some changes are live as soon as they are written. So dev stops before it makes any request when the login’s API base is production, and names the base and the flag. A local base, a stage base (*.stage.fluid.app) and a name under .test keep syncing without the flag. Any other base, a custom or unknown host included, is taken for production.
• It saves drafts and never publishes. A save is a push without --publish, with the same plan, refusals and stop at a stale version. Run fluid member-site publish when the draft is ready.
• It starts only when the server can show a draft. If it can’t, dev stops with “Draft preview is not available on this server yet” before it saves anything. It never shows the published page in its place.
• Each change is saved after a short pause. The command keeps serving when a save is refused, so you can fix the file. Reload the preview to see a save. There is no live reload yet.
• The preview is at http://127.0.0.1:<port>. / is the home page and /<slug> is another page. The server listens on 127.0.0.1 only, and your credential stays in the CLI. It never goes into a URL, a page or a header sent to the browser.

​

Know the folder

rileys-shop/
  layouts/site.liquid     sections/hero.liquid     snippets/card.liquid
  pages/index.liquid      pages/about.liquid
  assets/site.css         assets/site.js
  config/settings.json    config/menus.json        config/pages.json
  config/access.json      (only when the site declares what it uses)
  .member-site.json

​

config/settings.json

​

config/menus.json

{
  "menus": [
    {
      "slug": "main",
      "title": "Main menu",
      "items": [
        { "title": "Home", "page": "/" },
        { "title": "About", "page": "about" },
        { "title": "Contact", "url": "https://shop.example.com/contact" }
      ]
    }
  ]
}

​

config/pages.json

{
  "layout": null,
  "pages": [
    { "slug": "/", "title": "Home", "position": 1, "published": true, "layout": null, "menu": null },
    { "slug": "about", "title": "About", "position": 2, "published": true, "layout": null, "menu": "main" }
  ]
}

• layout at the top is the site’s default layout name, or null.
• Each row has a slug, title, position, published, layout and menu (a menu’s slug). The home page’s slug is /. A page slug is lowercase letters and digits separated by single hyphens, and never index.
• A page with a row and no file is a page whose content is a template the site doesn’t own.
• A site holds at most 50 pages. A new page needs a row and a file.

​

config/access.json

​

.member-site.json

​

Know what is live at once

​

Fix common errors

​

Next steps

• Build pages with Liquid covers the Liquid objects and the frame’s rules.
• Pages, menus and settings covers the three config files.
• Read viewer data in site scripts covers window.fluid.fetch.
• Declare what a member site uses covers config/access.json.
• Publish, restore, copy and take down a member site covers what a publish does and how to go back.
• Share a member site covers visibility and shares.
• Build member sites with the APIs covers building without the CLI.