1.. _moving-to-west:
2
3Moving to West
4##############
5
6To convert a "pre-west" Zephyr setup on your computer to west, follow these
7steps. If you are starting from scratch, use the :ref:`getting_started`
8instead. See :ref:`west-troubleshooting` for advice on common issues.
9
10#. Install west.
11
12   On Linux::
13
14     pip3 install --user -U west
15
16   On Windows and macOS::
17
18     pip3 install -U west
19
20   For details, see :ref:`west-install`.
21
22#. Move your zephyr repository to a new :file:`zephyrproject` parent directory,
23   and change directory there.
24
25   On Linux and macOS::
26
27     mkdir zephyrproject
28     mv zephyr zephyrproject
29     cd zephyrproject
30
31   On Windows ``cmd.exe``::
32
33     mkdir zephyrproject
34     move zephyr zephyrproject
35     chdir zephyrproject
36
37   The name :file:`zephyrproject` is recommended, but you can choose any name
38   with no spaces anywhere in the path.
39
40#. Create a :ref:`west workspace <west-workspace>` using the zephyr
41   repository as a local manifest repository::
42
43     west init -l zephyr
44
45   This creates :file:`zephyrproject/.west`, marking the root of your
46   workspace, and does some other setup. It will not change the contents of
47   the zephyr repository in any way.
48
49#. Clone the rest of the repositories used by zephyr::
50
51     west update
52
53   **Make sure to run this command whenever you pull zephyr.** Otherwise, your
54   local repositories will get out of sync. (Run ``west list`` for current
55   information on these repositories.)
56
57You are done: :file:`zephyrproject` is now set up to use west.
58