---
title: projects
description: Projectの計画・進捗・ライフサイクルを管理する。
canonical_url: https://orchestor.io/docs/cli/project
markdown_url: https://orchestor.io/docs/cli/project.md
contentType: reference
---

# projects

`orc projects` は、WorkspaceのProjectを作成し、担当者・日付・優先度などの計画を更新し、進捗の集計を確認するコマンドです。不要なProjectはアーカイブし、後から復元できます。

実行には認証とWorkspaceの選択が必要です。作成時の `project_key` はWorkspace内で一意な検索キーで、更新では変更できません。`get`、`update`、`archive`、`restore` にはこのキーを指定します。

## 使い方

```bash title="terminal"
orc projects list --json
```

*WorkspaceのProjectを一覧にします。*

## サブコマンド

### `list`

Projectを一覧にします。`--include-archived` でアーカイブ済みも含め、ページ数は `--limit` と `--cursor` で指定できます。

```bash title="terminal"
orc projects list [options]
```

#### 固有のオプション

##### `--workspace-id`

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: `string`。任意。

```bash title="terminal"
orc projects list --workspace-id <value>
```

##### `--include-archived`

Include archived projects in the response.; enum: true|false

型: `string`。任意。

```bash title="terminal"
orc projects list --include-archived <value>
```

### `create`

`project_key` と `name` を指定して作成します。作成時に状態を省略すると `planned` になります。同じWorkspaceの `initiative_id` や、マイルストーンのJSONを併せて指定できます。

```bash title="terminal"
orc projects create [options]
```

#### 固有のオプション

##### `--idempotency-key`

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: `string`。任意。

```bash title="terminal"
orc projects create --idempotency-key <value>
```

##### `--project-key`

(required) Project lookup key, unique within the workspace. Must not contain slash, backslash or two consecutive dots. This key cannot be changed through the update endpoint.

型: `string`。任意。

```bash title="terminal"
orc projects create --project-key <value>
```

##### `--name`

(required) Display name.

型: `string`。任意。

```bash title="terminal"
orc projects create --name <value>
```

##### `--status`

Project lifecycle status. Omitted on creation, it defaults to planned.; enum: planned|in_progress|paused|completed|canceled

型: `string`。任意。

```bash title="terminal"
orc projects create --status <value>
```

##### `--priority`

Project priority; null means unassigned.; enum: urgent|high|medium|low; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects create --priority <value>
```

##### `--lead-id`

Active workspace member id of the project lead. null means no lead is assigned.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects create --lead-id <value>
```

##### `--start-date`

Planned start as YYYY, YYYY-MM or YYYY-MM-DD. This is a calendar value, not a timestamp. null clears it.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects create --start-date <value>
```

##### `--target-date`

Target completion as YYYY, YYYY-MM or YYYY-MM-DD. This is a calendar value, not a timestamp. null clears it.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects create --target-date <value>
```

##### `--member-ids`

Active workspace member ids assigned to this project. The array replaces the current assignment on update; an empty array clears it. These assignments do not define the workspace access boundary.; csv

型: `string`。任意。

```bash title="terminal"
orc projects create --member-ids <value>
```

##### `--labels`

Project label values. The array replaces current labels on update; an empty array clears them. At most one label from each configured label group may be selected.; csv

型: `string`。任意。

```bash title="terminal"
orc projects create --labels <value>
```

##### `--start-precision`

Presentation precision for the planned start date. null leaves the precision unspecified.; enum: day|month|quarter|half_year|year; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects create --start-precision <value>
```

##### `--target-precision`

Presentation precision for the target date. null leaves the precision unspecified.; enum: day|month|quarter|half_year|year; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects create --target-precision <value>
```

##### `--summary`

Short project summary, separate from the detailed description. Null or empty clears it.; (use "null" or "reset" to clear); max 1000 chars

型: `string`。任意。

```bash title="terminal"
orc projects create --summary <value>
```

##### `--description`

Optional description.

型: `string`。任意。

```bash title="terminal"
orc projects create --description <value>
```

##### `--workspace-id`

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: `string`。任意。

```bash title="terminal"
orc projects create --workspace-id <value>
```

##### `--initiative-id`

Optional parent Initiative ID in the same Workspace.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects create --initiative-id <value>
```

##### `--milestone`

Optional embedded project milestone. Supply both name and date; omission or null stores no milestone. This does not create a record in the project milestones collection.

型: `string`。任意。

```bash title="terminal"
orc projects create --milestone <value>
```

##### `--display-order`

Project list ordering value; smaller values come first and equal values are ordered by projectKey. Creation appends after the current largest value when omitted.

型: `number`。任意。

```bash title="terminal"
orc projects create --display-order <value>
```

##### `--color-token`

Visual identity color token. Creation defaults to default when omitted.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red

型: `string`。任意。

```bash title="terminal"
orc projects create --color-token <value>
```

##### `--identity-kind`

Visual identity mode. Creation defaults to initial when omitted.; enum: color|initial|icon|emoji|image

型: `string`。任意。

```bash title="terminal"
orc projects create --identity-kind <value>
```

##### `--icon-token`

Icon token used with identity_kind=icon. null clears the stored token.; (use "null" or "reset" to clear); max 64 chars

型: `string`。任意。

```bash title="terminal"
orc projects create --icon-token <value>
```

##### `--emoji`

Emoji used with identity_kind=emoji. null clears the stored emoji.; (use "null" or "reset" to clear); max 32 chars

型: `string`。任意。

```bash title="terminal"
orc projects create --emoji <value>
```

##### `--image-file-id`

Uploaded image file id used with identity_kind=image. null clears the reference.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects create --image-file-id <value>
```

### `get`

Projectの検索キーを指定して詳細を取得します。組織スコープの認証情報では、必要に応じて `--workspace-id` で対象Workspaceを指定します。

```bash title="terminal"
orc projects get <key> [options]
```

#### 固有のオプション

##### `--workspace-id`

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: `string`。任意。

```bash title="terminal"
orc projects get <key> --workspace-id <value>
```

### `update`

名前、状態、優先度、担当者、日付、表示順、見た目やInitiativeへの所属を更新します。`visibility` は `workspace` または `private` の保存メタデータですが、このAPIの読み取り権限はWorkspace単位であり、`private` は別のメンバーアクセス境界を作りません。

```bash title="terminal"
orc projects update <key> [options]
```

#### 固有のオプション

##### `--workspace-id`

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --workspace-id <value>
```

##### `--name`

Project display name.

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --name <value>
```

##### `--status`

Project lifecycle status. Omitted on creation, it defaults to planned.; enum: planned|in_progress|paused|completed|canceled

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --status <value>
```

##### `--priority`

Project priority; null means unassigned.; enum: urgent|high|medium|low; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --priority <value>
```

##### `--lead-id`

Active workspace member id of the project lead. null means no lead is assigned.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --lead-id <value>
```

##### `--start-date`

Planned start as YYYY, YYYY-MM or YYYY-MM-DD. This is a calendar value, not a timestamp. null clears it.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --start-date <value>
```

##### `--target-date`

Target completion as YYYY, YYYY-MM or YYYY-MM-DD. This is a calendar value, not a timestamp. null clears it.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --target-date <value>
```

##### `--member-ids`

Active workspace member ids assigned to this project. The array replaces the current assignment on update; an empty array clears it. These assignments do not define the workspace access boundary.; csv

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --member-ids <value>
```

##### `--labels`

Project label values. The array replaces current labels on update; an empty array clears them. At most one label from each configured label group may be selected.; csv

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --labels <value>
```

##### `--start-precision`

Presentation precision for the planned start date. null leaves the precision unspecified.; enum: day|month|quarter|half_year|year; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --start-precision <value>
```

##### `--target-precision`

Presentation precision for the target date. null leaves the precision unspecified.; enum: day|month|quarter|half_year|year; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --target-precision <value>
```

##### `--summary`

Short project summary, separate from the detailed description. Null or empty clears it.; (use "null" or "reset" to clear); max 1000 chars

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --summary <value>
```

##### `--description`

Project description.

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --description <value>
```

##### `--display-order`

Project list ordering value; smaller values come first and equal values are ordered by projectKey. Creation appends after the current largest value when omitted.

型: `number`。任意。

```bash title="terminal"
orc projects update <key> --display-order <value>
```

##### `--visibility`

Stored project visibility metadata. Project reads in this API are authorized at workspace level; private does not create a separate member access boundary.; enum: workspace|private

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --visibility <value>
```

##### `--color-token`

Visual identity color token. Creation defaults to default when omitted.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --color-token <value>
```

##### `--identity-kind`

Visual identity mode. Creation defaults to initial when omitted.; enum: color|initial|icon|emoji|image

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --identity-kind <value>
```

##### `--icon-token`

Icon token used with identity_kind=icon. null clears the stored token.; (use "null" or "reset" to clear); max 64 chars

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --icon-token <value>
```

##### `--emoji`

Emoji used with identity_kind=emoji. null clears the stored emoji.; (use "null" or "reset" to clear); max 32 chars

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --emoji <value>
```

##### `--image-file-id`

Uploaded image file id used with identity_kind=image. null clears the reference.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --image-file-id <value>
```

##### `--initiative-id`

Optional parent Initiative ID in the same Workspace.; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --initiative-id <value>
```

##### `--milestone`

Embedded project milestone. Omit to preserve it, send null to clear it, or send both name and date to replace it. This does not update records managed by the project milestones collection.

型: `string`。任意。

```bash title="terminal"
orc projects update <key> --milestone <value>
```

### `restore`

アーカイブ済みProjectを検索キーで指定して復元します。

```bash title="terminal"
orc projects restore <key> [options]
```

#### 固有のオプション

##### `--idempotency-key`

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: `string`。任意。

```bash title="terminal"
orc projects restore <key> --idempotency-key <value>
```

### `archive`

Projectの検索キーを指定してアーカイブします。組織スコープの認証情報では、Projectが属するWorkspaceを `--workspace-id` で指定してください。

```bash title="terminal"
orc projects archive <key> [options]
```

#### 固有のオプション

##### `--idempotency-key`

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: `string`。任意。

```bash title="terminal"
orc projects archive <key> --idempotency-key <value>
```

##### `--workspace-id`

Workspace context. Organization-scoped credentials must supply a workspace in their organization. Workspace-scoped API keys remain bound to their authenticated workspace; this value cannot redirect them to another workspace.

型: `string`。任意。

```bash title="terminal"
orc projects archive <key> --workspace-id <value>
```

### `rollup get`

Project IDまたは既存のProjectキーを指定して進捗の集計を取得します。個別のProject設定の取得とは別の操作です。

```bash title="terminal"
orc projects rollup get <id> [options]
```

## 使用例

### 検索キーと名前を指定してProjectを作成します。

```bash title="terminal"
orc projects create --project-key launch-plan --name "Launch plan" --json
```

*検索キーと名前を指定してProjectを作成します。*

### 進行中へ変更します。

```bash title="terminal"
orc projects update launch-plan --status in_progress --json
```

*進行中へ変更します。*

### 進捗を集計します。

```bash title="terminal"
orc projects rollup get launch-plan --json
```

*進捗を集計します。*

### アーカイブしたProjectを復元します。

```bash title="terminal"
orc projects restore launch-plan --json
```

*アーカイブしたProjectを復元します。*

## Projectキーと所属

`project_key` には `/`、`\`、連続する `..` を含められません。IssueにProjectを関連付ける `project_id` はUUIDであり、この検索キーとは異なります。Initiativeへの所属は同じWorkspace内で指定し、解除するときは更新本文の `initiative_id` を `null` にします。マイルストーンの管理には `orc projects milestones` を使用します。

## グローバルオプション

`orc projects` では、次の[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を使用できます。

- [`--help`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%98%E3%83%AB%E3%83%97)
- [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9)
- [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B)
- [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B)
- [`--format`](https://orchestor.io/docs/cli/global-flags.md#%E5%87%BA%E5%8A%9B%E5%BD%A2%E5%BC%8F)
- [`--field`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA)
- [`--fields`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA)
- [`--raw`](https://orchestor.io/docs/cli/global-flags.md#%E5%80%A4%E3%81%A0%E3%81%91%E3%82%92%E5%87%BA%E5%8A%9B)
- [`--output`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E5%87%BA%E5%8A%9B)
- [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%9A%E3%83%BC%E3%82%B8%E9%80%81%E3%82%8A)
- [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E4%BA%8B%E5%89%8D%E7%A2%BA%E8%AA%8D)
- [`--yes`](https://orchestor.io/docs/cli/global-flags.md#%E7%A2%BA%E8%AA%8D%E3%81%AE%E7%9C%81%E7%95%A5)
- [`--limit`](https://orchestor.io/docs/cli/global-flags.md)
- [`--cursor`](https://orchestor.io/docs/cli/global-flags.md)
- [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B)
- [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B)
- [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E5%8F%96%E5%BE%97)
- [`--timing`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E6%99%82%E9%96%93)
- [`--readonly`](https://orchestor.io/docs/cli/global-flags.md#%E8%AA%AD%E3%81%BF%E5%8F%96%E3%82%8A%E5%B0%82%E7%94%A8%E3%83%A2%E3%83%BC%E3%83%89)
- [`--wrap-untrusted`](https://orchestor.io/docs/cli/global-flags.md#%E5%A4%96%E9%83%A8%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AE%E7%9B%AE%E5%8D%B0%E4%BB%98%E3%81%91)

各オプションの詳細と使用例は、[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を参照してください。

---

[Documentation index](https://orchestor.io/docs/llms.txt)