> For the complete documentation index, see [llms.txt](https://commandbox.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://commandbox.ortusbooks.com/5.9.0/package-management/box-json/basic-package-data.md).

# Basic Package Data

The following box.json properties provide basic information about what your package is.

## name

**string**

Name of the package. Short, but descriptive.

```bash
package set name="Whiz Bang Module"
package show name
```

## slug

**string**

The unique slug for this package. Cannot contain spaces or special characters. Can contain a hyphen. Use the `forgebox slugcheck` command to see if this slug is already in use. This is what people will use when installing your package from ForgeBox.

```bash
package set slug="whiz-bang"
package show slug
```

## version

**string**

The semantic version of your package following the pattern `major.minor.patch.build`. Ex: `2.3.5.0012`

```bash
package set version=1.0.0.0000
package show version
```

## author

**string**

The name of the author of the module as a string.

```bash
package set author="Brad Wood <brad@bradwood.com>"
package show author
```

## shortDescription

**string**

Describes what this package is in a couple sentences. Save the dissertation for the `description`.

```bash
package set description="Install this module to add a bit of Whiz Bang to your app."
package show description
```

## private

**boolean**

A flag that designates if this package is a ForgeBox private package. ForgeBox private packages are not publicly accessible, but offer all the benefits of ForgeBox. Private packages will be a paid feature for ForgeBox Pro subscribers, though the feature is currently available to all users for free.

```bash
package set private=false
package show private
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://commandbox.ortusbooks.com/5.9.0/package-management/box-json/basic-package-data.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
