Lines Matching +full:west +full:- +full:commands
1 .. _west-basics:
6 This page introduces west's basic concepts and provides references to further
9 West's built-in commands allow you to work with *projects* (Git
18 .. code-block:: none
20 zephyrproject/ # west topdir
21 ├── .west/ # marks the location of the topdir
22 │ └── config # per-workspace local configuration file
24 │ # The manifest repository, never modified by west after creation:
26 │ ├── west.yml # manifest file
29 │ # Projects managed by west:
33 ├── net-tools/ # .git/ project
36 .. _west-workspace:
42 Additional details are in :ref:`west-workspaces`.
47 -- it could be anything, like ``z``, ``my-zephyr-workspace``, etc.)
50 using :ref:`west init <west-init-basics>`.
52 .west directory
53 The topdir contains the :file:`.west` directory. When west needs to find
54 the topdir, it searches for :file:`.west`, and uses its parent directory.
60 The file :file:`.west/config` is the workspace's :ref:`local configuration
61 file <west-config>`.
64 Every west workspace contains exactly one *manifest repository*, which is a
67 <west-config-index>` in the local configuration file.
70 configure west to use any Git repository in the workspace as the manifest
72 See :ref:`west-topologies` for information on other options, and
73 :ref:`west-manifests` for details on the manifest file format.
77 additional Git repositories in the workspace managed by west. The manifest
78 file is named :file:`west.yml` by default; this can be overridden using the
81 You use the :ref:`west update <west-update-basics>` command to update the
85 Projects are Git repositories managed by west. Projects are defined in the
87 example workspace, ``tinycbor`` and ``net-tools`` are projects.
89 By default, the Zephyr :ref:`build system <build_overview>` uses west to get
94 Any repository known to west (either the manifest repository or any project
95 repository) can define :ref:`west-extensions`. Extensions are extra west
96 commands you can run when using that workspace.
98 The zephyr repository uses this feature to provide Zephyr-specific commands
99 like :ref:`west build <west-building>`. Defining these as extensions keeps
100 west's core agnostic to the specifics of any workspace's Zephyr version,
105 directories not managed by west. West basically ignores anything in the
106 workspace except :file:`.west`, the manifest repository, and the projects
109 west init and west update
112 The two most important workspace-related commands are ``west init`` and ``west
115 .. _west-init-basics:
117 ``west init`` basics
118 --------------------
120 This command creates a west workspace.
124 West doesn't change your manifest repository contents after ``west init`` is
125 run. Use ordinary Git commands to pull new versions, etc.
129 .. code-block:: shell
131 west init -m https://github.com/zephyrproject-rtos/zephyr --mr v2.5.0 zephyrproject
136 :file:`.west` and :file:`.west/config` inside it
138 https://github.com/zephyrproject-rtos/zephyr, placing it into
141 #. Set ``manifest.path`` to ``zephyr`` in :file:`.west/config`
142 #. Set ``manifest.file`` to ``west.yml``
144 Your workspace is now almost ready to use; you just need to run ``west update``
147 For more details, see :ref:`west-init`.
149 .. _west-update-basics:
151 ``west update`` basics
152 ----------------------
160 should run ``west update`` to make sure your workspace contains the
163 The ``west update`` command reads the manifest file's contents by:
165 #. Finding the topdir. In the ``west init`` example above, that
167 #. Loading :file:`.west/config` in the topdir to read the ``manifest.path``
168 (e.g. ``zephyr``) and ``manifest.file`` (e.g. ``west.yml``) options.
170 :file:`zephyrproject/zephyr/west.yml`).
178 For more details, see :ref:`west-update`.
180 Other built-in commands
183 See :ref:`west-built-in-cmds`.
185 .. _west-zephyr-extensions:
190 See the following pages for information on Zephyr's extension commands:
192 - :ref:`west-build-flash-debug`
193 - :ref:`west-sign`
194 - :ref:`west-zephyr-ext-cmds`
195 - :ref:`west-shell-completion`
200 See :ref:`west-troubleshooting`.