What is a project key in LocalPM?

The key is a short code that identifies a project in LocalPM. It shows on the project's card on the dashboard and forms part of the project's address, for example #/projects/WEB/board.

How keys work

• Uppercase: whatever you type in the Key field is converted to uppercase.
• Up to 6 characters: the field won't accept more than six.
• Auto-suggested: as you type the Project Name, LocalPM fills in a key from the first 5 letters of the name, skipping spaces, numbers, and punctuation. "Website Redesign" becomes WEBSI, for example.
• Editable before you create: you can overwrite the suggestion with anything you prefer. Once you've typed your own key, changing the name no longer replaces it.

Choosing a good key

• Keep it short and recognizable: WEB, MKTG, HR, Q3OPS.
• Use a different key for every project. LocalPM doesn't check for duplicates, and because projects are opened by key, two projects with the same key can't both be reached reliably.
• Pick something that will still make sense later. There's no way to rename a project or change its key after it's created.

Bookmarking a project

Because the key is part of the address, you can bookmark a project view directly, such as its board or backlog. The bookmark only works in the same browser where the project's data is stored. See Where does LocalPM store my data?

Made a mistake?

If you've created a project with the wrong key, the simplest fix is to create a new project with the key you want and recreate the stories there. Projects can't be deleted from the interface; How do I reset LocalPM or delete a project? explains your options.

For more on setting up a new project, see Creating a Project From Scratch: LocalPM Setup Guide.