lamin

For a guide, see: Install & setup.

Usage: lamin [OPTIONS] COMMAND [ARGS]...

  Configure LaminDB and perform simple actions.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  cache     Manage cache.
  close     Close existing instance.
  delete    Delete instance.
  get       Get an object from a lamin.ai URL.
  info      Show user & instance info.
  init      Init a lamindb instance.
  load      Auto-connect to a lamindb instance.
  login     Login using an email or user handle.
  logout    Logout.
  migrate   Manage migrations.
  register  Register an instance on the hub.
  save      Save file or folder.
  schema    View schema.
  set       Update settings.```

lamin info

Usage: lamin info [OPTIONS]

  Show user & instance info.

Options:
  --help  Show this message and exit.```

lamin init

Usage: lamin init [OPTIONS]

  Init a lamindb instance.

Options:
  --storage TEXT  local dir, s3://bucket_name, gs://bucket_name
  --db TEXT       postgres database connection URL, do not pass for SQLite
  --schema TEXT   comma-separated string of schema modules
  --name TEXT     instance name
  --help          Show this message and exit.```

lamin login

Usage: lamin login [OPTIONS] USER

  Login using an email or user handle.

Options:
  --key TEXT       API key
  --password TEXT  legacy password
  --help           Show this message and exit.```

lamin logout

Usage: lamin logout [OPTIONS]

  Logout.

Options:
  --help  Show this message and exit.```

lamin load

Usage: lamin load [OPTIONS] IDENTIFIER

  Auto-connect to a lamindb instance.

  Identifier can be slug (account_handle/instance_name) or url
  (https://lamin.ai/account_handle/instance_name).

  If the owner is the current user the instance_name suffices.

Options:
  --db TEXT       Update database URL.
  --storage TEXT  Update storage while loading.
  --help          Show this message and exit.```

lamin delete

Usage: lamin delete [OPTIONS] INSTANCE

  Delete instance.

Options:
  --force  Do not ask for confirmation.
  --help   Show this message and exit.```

lamin set

Usage: lamin set [OPTIONS] {auto-connect} VALUE

  Update settings.

Options:
  --help  Show this message and exit.```

lamin close

Usage: lamin close [OPTIONS]

  Close existing instance.

Options:
  --help  Show this message and exit.```

lamin register

Usage: lamin register [OPTIONS]

  Register an instance on the hub.

Options:
  --help  Show this message and exit.```

lamin schema

Usage: lamin schema [OPTIONS] {view}

  View schema.

Options:
  --help  Show this message and exit.```

lamin save

Usage: lamin save [OPTIONS] FILEPATH

  Save file or folder.

Options:
  --key TEXT
  --description TEXT
  --help              Show this message and exit.```

lamin get

Usage: lamin get [OPTIONS] URL

  Get an object from a lamin.ai URL.

Options:
  --help  Show this message and exit.```

lamin cache

Usage: lamin cache [OPTIONS] COMMAND [ARGS]...

  Manage cache.

Options:
  --help  Show this message and exit.

Commands:
  clear  Clear the cache directory.
  get    Get the cache directory.
  set    Set the cache directory.```

lamin cache set

Usage: lamin cache set [OPTIONS] CACHE_DIR

  Set the cache directory.

Options:
  --help  Show this message and exit.```

lamin cache clear

Usage: lamin cache clear [OPTIONS]

  Clear the cache directory.

Options:
  --help  Show this message and exit.```

lamin cache get

Usage: lamin cache get [OPTIONS]

  Get the cache directory.

Options:
  --help  Show this message and exit.```

lamin migrate

Usage: lamin migrate [OPTIONS] COMMAND [ARGS]...

  Manage migrations.

Options:
  --help  Show this message and exit.

Commands:
  create  Create a new migration.
  deploy  Deploy migrations.
  squash  Squash migrations.```

lamin migrate create

Usage: lamin migrate create [OPTIONS]

  Create a new migration.

Options:
  --help  Show this message and exit.```

lamin migrate deploy

Usage: lamin migrate deploy [OPTIONS]

  Deploy migrations.

Options:
  --help  Show this message and exit.```

lamin migrate squash

Usage: lamin migrate squash [OPTIONS]

  Squash migrations.

Options:
  --package-name TEXT
  --end-number TEXT
  --start-number TEXT
  --help               Show this message and exit.```