How to Create a Custom Module in Odoo 19 Using Scaffold Command (Step-by-Step Guide)

How to Create a Custom Module in Odoo 19 Using Scaffold Command (Step-by-Step Guide)

If you are starting your journey in Odoo development, one of the first things you must learn is how to create a custom module. In Odoo, every feature is built as a module — whether it’s Sales, Inventory, Accounting, or your own custom functionality.

In this tutorial, you will learn:

  • What the scaffold command is in Odoo

  • How to create a custom module in Odoo 19

  • Understanding the generated folder structure

This guide is beginner-friendly and practical.

What is the Scaffold Command in Odoo?

The scaffold command is a built-in command provided by Odoo that automatically generates the basic folder structure of a new module.

Instead of manually creating folders like:

  • models

  • views

  • controllers

  • security

Odoo creates everything for you in seconds.

This saves time and ensures your module follows Odoo’s development standards.



Prerequisites Before Creating a Module

Before running the scaffold command, make sure you have:

  • Odoo 19 installed

  • Python installed

  • A running database server like PostgreSQL

  • Custom addons path configured in your Odoo configuration file

Your custom addons folder might look like:

/odoo-19.0/custom_addons/


Make sure this path is added in your odoo.conf file:

--addons_path = addons,custom_addons


Odoo 19 addons path example



Step-by-Step Guide to Create Module Using Scaffold

Now let’s create a module called:

your_module_name


Step 1: Navigate to Odoo Directory

Open your terminal and go to your Odoo project directory:

cd /path/to/odoo-19


Make sure you can see:

odoo-bin

addons/



Step 2: Run the Scaffold Command

Now run:

python odoo-bin scaffold your_module_name custom_addons/


Explanation:

  • odoo-bin → Main Odoo executable file

  • scaffold → Command to generate module

  • shop_inventory → Your module name

  • custom_addons/ → Folder where module will be created

After running this command, Odoo will generate a new folder inside custom_addons.


Odoo 19 scaffold command terminal example



Generated Folder Structure

Your newly created module will look like this:

your_module_name/

 ├── __init__.py

 ├── __manifest__.py

 ├── controllers/

 ├── models/

 ├── views/

 ├── security/

 └── static/


Odoo 19 module Structure Example

Why Scaffold Command is Important for Beginners

The scaffold command:

  • Saves development time

  • Creates correct structure

  • Reduces folder mistakes

  • Follows Odoo standards

Every Odoo developer starts with a scaffold when creating a new custom module.


Conclusion

Creating a custom module in Odoo 19 using the scaffold command is the first step toward mastering Odoo development.

In this tutorial, you learned:

  • What scaffold command does

  • How to create a module

  • Folder structure

If you are serious about becoming an Odoo developer, practice by:

  • Creating multiple sample modules

  • Adding custom models

  • Creating form and tree views

  • Implementing security access

This is how you build strong technical skills in Odoo.

Comments

Post a Comment

Popular posts from this blog

How I Solved the PostgreSQL Collation Error While Setup Odoo19 Development Environment on Windows?

If you’ve ever tried Setup Development Environment on a Windows machine for Odoo, you probably know that it can be a little tricky. Recently, I ran into one of those frustrating moments — everything seemed to be going well until I hit a strange PostgreSQL error I’d never seen before. I have followed the documentation for Setup Odoo19 Development Environment on my Windows system. Here’s the story of what happened, what caused it, and how I fixed it. Hopefully, this will save you a few hours of head-scratching! 🚧 The Problem After setting up my environment and trying to start Odoo, I got this error: psycopg2.OperationalError: connection to server at "localhost" (::1), port 5432 failed:  FATAL:  collations with different collate and ctype values are not supported on this platform 1. Check What locale database using Open PgAdmin4, Query tool and execute the following query. select datname, datcollate, datctype from pg_database select * from pg_collation; 2. Drop Problematic Data...
Read more

Odoo 19 Scaffold Folder Structure Explained: Complete Guide for Developers

Image
Odoo 19 Scaffold Folder Structure Explained: Complete Guide for Developers Introduction When developing a custom module in Odoo 19, the first step is usually running the scaffold command. This automatically generates a ready-to-use module structure. Understanding this folder structure is essential for clean, scalable module development. What is the Scaffold Command in Odoo? The scaffold command is a built-in command provided by Odoo that automatically generates the basic folder structure of a new module. Instead of manually creating folders like: models views controllers security Odoo creates everything for you in seconds. This saves time and ensures your module follows Odoo’s development standards. Generated Folder Structure Your newly created module will look like this: your_module_name/  ├── __init__.py  ├── __manifest__.py  ├── controllers/  ├── models/  ├── views/  ├── security/  └── static/ Now let’s understand each file and folder. 1. init.py ...
Read more