sqlmodel migrations command not found in version 0.0.27

[heavenyoung1]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the SQLModel documentation, with the integrated search.
• I already searched in Google "How to X in SQLModel" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to SQLModel but to Pydantic.
• I already checked if it is not related to SQLModel but to SQLAlchemy.

Commit to Help

• I commit to help with one of those options 👆

Example Code

At this stage, the content of the tables is not important, but I will send them anyway.

from datetime import datetime
from typing import Optional, TYPE_CHECKING
from sqlmodel import SQLModel, Field, Relationship

if TYPE_CHECKING:

    from backend.infrastructure.models.matter import Case
class Contact(SQLModel, table=True):

    id: int = Field(primary_key=True)
    name: str = Field(max_length=100, description='Data')
    personal_info: Optional[str] = Field(default=None, description='Passpotrt', max_length=20)
    phone: Optional[str] = Field(default=None, max_length=20)
    email: Optional[str] = Field(default=None, max_length=50)
    created_at: datetime = Field(default_factory=datetime.now(tz=None)) # type: ignore

    case_id: int = Field(foreign_key='cases.id', index=True)

    # relationships
    case: Optional[Case] = Relationship(back_populates='contacts')

Description

Environment:

• OS: Linux Ubuntu LTS 24.02
• SQLModel version: sqlmodel>=0.0.27
• Alembic version: alembic>=1.17.1
• Python version: 3.13.3

When following the documentation and trying to run sqlmodel migrations init, the command is not found:
(bloom) evgeny@ubuntu2402:~/projects/bloom$ sqlmodel migrations init sqlmodel: command not found

However, the equivalent Alembic command works correctly:
(bloom) evgeny@ubuntu2402:~/projects/bloom$ alembic init alembic Creating directory /home/evgeny/projects/bloom/alembic ... done Creating directory /home/evgeny/projects/bloom/alembic/versions ... done Generating /home/evgeny/projects/bloom/alembic.ini ... done Generating /home/evgeny/projects/bloom/alembic/script.py.mako ... done Generating /home/evgeny/projects/bloom/alembic/env.py ... done Generating /home/evgeny/projects/bloom/alembic/README ... done Please edit configuration/connection/logging settings in /home/evgeny/projects/bloom/alembic.ini before proceeding.

Is the sequence of actions for initializing migrations using SQLModel described accurately enough in the documentation? The fact that alembic executed the command successfully, but SQLModel did not, suggests that I may be doing something wrong.

Operating System

Linux

Operating System Details

Ubuntu 24.04.2 LTS

SQLModel Version

0.0.27

Python Version

3.13.3

Additional Context

No response

[YuriiMotov]

When following the documentation and trying to run sqlmodel migrations init

Could you please share a link to the page of docs where you found sqlmodel migrations init command?

[heavenyoung1]

Of course, here is the link

[YuriiMotov]

Of course, here is the link

This link points to docs preview of one of pull requests (look at the domain name - https://f87a6f0c.sqlmodel.pages.dev). Official docs are at: https://sqlmodel.tiangolo.com/

[heavenyoung1]

The sqlmodel migrations init command has not yet been implemented in the public version and only exists in the development branch. I understand, thank you for the information.