'\" t
.\"     Title: rad-id
.\"    Author: The Radicle Team
.\" Generator: Asciidoctor 2.0.26
.\"      Date: 2026-08-28
.\"    Manual: Radicle CLI Manual
.\"    Source: rad 1.0.0
.\"  Language: Persian
.\"
.TH "RAD\-ID" "1" "2026-08-28" "rad 1.0.0" "Radicle CLI Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "نام (NAME)"
rad-id \- مدیریت تغییرات هویت یک مخزن Radicle.
.SH "خلاصه دستور (SYNOPSIS)"
.sp
\fBrad id\fP [<option>.\|.\|.]
.br
\fBrad id\fP \fIlist\fP [<option>.\|.\|.]
.br
\fBrad id\fP \fIupdate\fP [\-\-title <string>] [\-\-description <string>] <option>.\|.\|.
.br
\fBrad id\fP \fIedit\fP <revision\-id> [\-\-title <string>] [\-\-description <string>] [<option>.\|.\|.]
.br
\fBrad id\fP \fIshow\fP <revision\-id> [<option>.\|.\|.]
.br
\fBrad id\fP \fIaccept\fP | \fIreject\fP <revision\-id> [<option>.\|.\|.]
.br
\fBrad id\fP \fIredact\fP <revision\-id> [<option>.\|.\|.]
.br
.SH "توضیحات (DESCRIPTION)"
.sp
دستور \fBrad id\fP برای مدیریت و پیشنهاد تغییرات در هویت یک مخزن Radicle استفاده
می‌شود. هر مخزن دارای یک سند هویت (identity document) مرتبط است که شامل
متادیتاهایی مانند نام مخزن، توضیحات و نمایندگان (delegates) است. سند هویت
نسخه‌بندی می‌شود و تغییرات اعمال‌شده بر روی آن باید توسط حد نصاب (quorum)
نمایندگان امضا شود.
.sp
سند هویت به‌صورت یک سند \fICanonical JSON\fP ذخیره می‌شود.
.SH "دستورها (COMMANDS)"
.sp
بدون هیچ آرگومانی، \fBrad id\fP به‌طور پیش‌فرض دستور \fIlist\fP را اجرا می‌کند که
فهرستی از بازبینی‌های (revisions) هویت مخزن جاری را نشان می‌دهد.
.SS "list"
.sp
فهرست کردن تمام بازبینی‌های سند هویت.
.SS "update"
.sp
پیشنهاد یک بازبینی جدید برای سند هویت. بازبینی‌ها علاوه بر سند هویت به‌روزشده
پیشنهادی، درست مانند کامیت‌های کد منبع دارای یک عنوان و توضیحات هستند.
.sp
اگر عنوان و توضیحات در خط فرمان مشخص نشوند، از شما خواسته می‌شود که از طریق
ویرایشگر متنی خود آن‌ها را وارد کنید.
.sp
توجه داشته باشید که اگر شما تنها نمایندهٔ مخزن باشید، تغییرات پیشنهادی به‌طور
خودکار پذیرفته شده و در سند هویت گنجانده می‌شوند.
.sp
\fB\-\-title\fP \fI<string>\fP
.RS 4
تنظیم عنوان برای بازبینی جدید.
.RE
.sp
\fB\-\-description\fP \fI<string>\fP
.RS 4
تنظیم توضیحات برای بازبینی جدید.
.RE
.sp
\fB\-\-delegate\fP \fI<did>\fP
.RS 4
به‌روزرسانی هویت با افزودن یک نماینده جدید که با DID او مشخص می‌شود.
.RE
.sp
\fB\-\-rescind\fP \fI<did>\fP
.RS 4
به‌روزرسانی هویت با حذف نماینده‌ای که با DID او مشخص می‌شود.
.RE
.sp
\fB\-\-threshold\fP \fI<num>\fP
.RS 4
به‌روزرسانی هویت با تنظیم تعداد نمایندگان مورد نیاز برای پذیرش یک بازبینی.
.RE
.sp
\fB\-\-visibility\fP \fI<private>\fP | \fI<public>\fP
.RS 4
به‌روزرسانی هویت با تنظیم میزان پدیداری مخزن روی خصوصی (private) یا عمومی (public).
.RE
.sp
\fB\-\-allow\fP \fI<did>\fP
.RS 4
به‌روزرسانی هویت با اعطای دسترسی به یک همتای (peer) مشخص برای یک مخزن خصوصی.
.RE
.sp
\fB\-\-disallow\fP \fI<did>\fP
.RS 4
به‌روزرسانی هویت با لغو دسترسی یک همتای مشخص به یک مخزن خصوصی. توجه داشته باشید
که همتا ممکن است محتوای مخزن را تا لحظه لغو دسترسی در اختیار داشته باشد.
.RE
.sp
\fB\-\-payload\fP \fI<id> <key> <val>\fP
.RS 4
به‌روزرسانی هویت با تنظیم متادیتا در یکی از محموله‌های (payloads) هویت. برای مثال،
این گزینه می‌تواند برای به‌روزرسانی نام پروژه یا توضیحات مخزن استفاده شود. برای
حذف یک فیلد از یک محموله، کافی است مقدار آن را روی \fBnull\fP تنظیم کنید.
.RE
.sp
\fB\-\-no\-confirm\fP
.RS 4
عدم درخواست تایید پیش از ایجاد بازبینی.
.RE
.sp
\fB\-\-edit\fP
.RS 4
باز کردن ویرایشگر شما ($EDITOR) برای ویرایش مستقیم محتوای JSON.
.RE
.SS "edit"
.sp
ویرایش یک بازبینی موجود از سند هویت. بازبینی باید همچنان در وضعیت «فعال» (active)
باشد. همان گزینه‌های موجود برای \fBupdate\fP در اینجا نیز در دسترس هستند. توجه
داشته باشید که این دستور یک بازبینی پیشنهادی هویت را ویرایش می‌کند؛ برای ویرایش خود
سند هویت، از \fBupdate\fP استفاده کنید.
.SS "show"
.sp
نمایش یک بازبینی مشخص از سند هویت.
.SS "accept"
.sp
پذیرفتن یک بازبینی پیشنهادی برای سند هویت. بازبینی باید در وضعیت «فعال» (active)
بوده و فراخواننده باید یک نماینده باشد.
.SS "reject"
.sp
رد کردن یک بازبینی پیشنهادی برای سند هویت. بازبینی باید در وضعیت «فعال» (active)
بوده و فراخواننده باید یک نماینده باشد.
.SS "redact"
.sp
حذف یا بازپس‌گیری (redact) یک بازبینی موجود از سند هویت. بازبینی نباید در وضعیت
«پذیرفته‌شده» (accepted) باشد و فراخواننده باید نویسندهٔ بازبینی باشد.
.SH "گزینه‌ها (OPTIONS)"
.sp
\fB\-\-repo\fP \fI<rid>\fP
.RS 4
مشخص کردن مخزنی که عملیات روی آن انجام می‌شود. پیش‌فرض مخزن جاری است.
.RE
.sp
\fB\-\-quiet\fP, \fB\-q\fP
.RS 4
جلوگیری از چاپ خروجی.
.RE
.sp
\fB\-\-help\fP
.RS 4
نمایش اطلاعات راهنما.
.RE
.SH "مثال‌ها (EXAMPLES)"
.SS "افزودن یک نماینده (Adding a delegate)"
.sp
برای افزودن یک نماینده جدید به مخزن و به‌روزرسانی حد نصاب، از دستور \fBupdate\fP
استفاده کنید:
.sp
.if n .RS 4
.nf
.fam C
$ rad id update \-\-title "Add Bob" \-\-description "Add Bob as a delegate" \(rs
    \-\-delegate did:key:z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk \(rs
    \-\-threshold 2
.fam
.fi
.if n .RE
.sp
این دستور بازبینی جدیدی ایجاد می‌کند که پیشنهاد افزودن نمایندهٔ مشخص‌شده با DID
ارائه‌شده را ثبت کرده و حد نصاب را روی \f(CR2\fP قرار می‌دهد، به این معنی که دو
نماینده باید تغییرات بعدی هویت را امضا و تایید کنند.
.SS "تغییر میزان پدیداری مخزن (Changing repository visibility)"
.sp
برای تغییر وضعیت یک مخزن از عمومی به خصوصی:
.sp
.if n .RS 4
.nf
.fam C
$ rad id update \-\-visibility private
.fam
.fi
.if n .RE
.sp
توجه داشته باشید که برای اعمال این تغییر، نیاز به پذیرش توسط حد نصاب نمایندگان
وجود دارد.
.SS "تغییر یک محموله مخزن (Changing a repository payload)"
.sp
تغییر نام و توضیحات یک مخزن معمولاً از طریق محمولهٔ \fBxyz.radicle.project\fP
انجام می‌شود:
.sp
.if n .RS 4
.nf
.fam C
$ rad id update \-\-title "Update title and description" \(rs
    \-\-description "Improve clarity" \(rs
    \-\-payload xyz.radicle.project name \*(Aq"radicle\-beans"\*(Aq \(rs
    \-\-payload xyz.radicle.project description \*(Aq"Tasty Radicle beans"\*(Aq
.fam
.fi
.if n .RE
.sp
توجه داشته باشید که مقادیر ارائه‌شده به \fB\-\-payload\fP، مانند \f(CR"radicle\-beans"\fP،
باید مقادیر معتبر \fIJSON\fP باشند. این به این معنی است که رشته‌ها باید همان‌طور که
در مثال بالا نشان داده شده است، درون علامت نقل‌قول دوتایی (double quotes) قرار گیرند.
.SS "حذف یک نماینده (Removing a delegate)"
.sp
برای حذف یک نماینده و به‌روزرسانی حد نصاب، از گزینهٔ \fB\-\-rescind\fP استفاده کنید:
.sp
.if n .RS 4
.nf
.fam C
$ rad id update \-\-title "Remove Bob" \(rs
    \-\-description "Bob is no longer a delegate" \(rs
    \-\-rescind did:key:z6Mkt67GdsW7715MEfRuP4pSZxJRJh6kj6Y48WRqVv4N1tRk \(rs
    \-\-threshold 1
.fam
.fi
.if n .RE
.sp
همانند افزودن یک نماینده، این تغییر نیز نیازمند تایید نمایندگان باقی‌مانده است.
هنگام حذف نمایندگان، مطمئن شوید که حد نصاب جدید مناسبی تعیین می‌کنید!
.SS "افزودن قوانین ارجاع‌های رسمی (Adding Canonical References Rules)"
.sp
برای به‌روزرسانی قوانین ارجاع‌های رسمی پروژه، هنگام به‌روزرسانی از گزینهٔ
\f(CR\-\-payload xyz.radicle.crefs\fP با کلید \f(CRrules\fP و شیء حاوی قوانین
به عنوان مقدار استفاده کنید. نمونه‌ای از آن در ادامه آورده شده است:
.sp
.if n .RS 4
.nf
.fam C
$ rad id update \-\-title "Update canonical reference rules" \(rs
    \-\-payload xyz.radicle.crefs rules \*(Aq{
          "refs/heads/master": { "threshold": 1, "allow": "delegates" },
          "refs/tags/*": { "threshold": 2, "allow": "delegates" },
          "refs/tags/qa/*": { "threshold": 1, "allow": "delegates" }
      }\*(Aq
.fam
.fi
.if n .RE
.sp
علاوه بر این، می‌توانید از گزینهٔ \f(CR\-\-edit\fP در دستور \f(CRupdate\fP استفاده
کرده و محموله را مستقیماً ویرایش کنید. نمونه‌ای از آنچه مشاهده خواهید کرد به این صورت
است:
.sp
.if n .RS 4
.nf
.fam C
{
  "payload": {
    "xyz.radicle.crefs": {
      "rules": {
        "refs/heads/master": {
          "allow": "delegates",
          "threshold": 1
        },
        "refs/tags/*": {
          "allow": "delegates",
          "threshold": 1
        },
        "refs/tags/qa/*": {
          "allow": "delegates",
          "threshold": 1
        }
      }
    },
    "xyz.radicle.project": {
      "defaultBranch": "master",
      "description": "Radicle Heartwood Protocol & Stack",
      "name": "heartwood"
    }
  },
  "delegates": [
    "did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi"
  ],
  "threshold": 1
}
.fam
.fi
.if n .RE
.SH "نویسندگان (AUTHORS)"
.sp
تیم Radicle