Skip to main content

​
Prerequisites

Check your Node version before installing:
Install once and run fjall from any directory:
A global install gets the latest major. When you upgrade later, keep the CLI major in step with your application’s @fjall/components-infrastructure pin. A deploy-time engine compatibility check refuses mismatched pairings before anything in AWS is touched.

​
Install in a project

Pin the CLI to a repository so every contributor and CI job runs the same version.
  1. Initialise the project if it has no package.json:
  2. Install the CLI as a dev dependency:
  3. Add a script (optional):
  4. Run commands through npx or the script:

​
Verify the install

The command prints the installed version number.

​
Sign in

Authenticate before anything else. Without a Fjall session, fjall create, fjall connect and fjall deploy refuse under --non-interactive or --agent, naming the cure. The one exception is fjall create app --offline, which writes the scaffold but registers nothing. Interactively, each asks Would you like to log in now? instead. Yes, the default, opens your browser to sign in. No carries on without a session: fjall create organisation, fjall create account, fjall connect and fjall deploy then refuse before they change anything, and fjall create app registers nothing with Fjall.
In a terminal, fjall login starts the browser device-code flow straight away and opens your browser for you. It prints a verification URL and a user code, then waits for you to approve. If the browser does not open, press E at that step to paste an API key instead. Credentials are written to ~/.fjall/auth.json, or to $FJALL_CONFIG_DIR/auth.json when that variable is set. Fjall never writes ~/.aws/config or ~/.aws/credentials, but the AWS SDK can still read a profile from them, such as the one an exported AWS_PROFILE names (see The AWS SDK can still read your AWS profiles). In CI, skip fjall login and export a deploy token instead. Mint the token in the Fjall web app under Settings → CI/CD Tokens:
FJALL_API_KEY takes precedence over the saved credentials file, so the same commands work locally and in a pipeline.

​
Next Steps

Sign In

Device-code flow, API keys, and the --org flag for multi-organisation setups.

Connect AWS

Run fjall connect to link an AWS account through OIDC federation.

Create Application

Scaffold a standalone application. Best for single accounts, prototypes, or quick starts.

Deploy Organisation

Set up a multi-account AWS environment with OIDC federation, SSO, and account separation.
Not sure which to choose? Sign in, connect an account, then create an application. You can add organisation structure later.