Development

Command Line Interface Design

Context level

The repository-service-tuf, in the context perspective, is a command line tool. It sends HTTP requests to repository-service-tuf-api.

Container level

The repository-service-tuf, in the container perspective, is a command line tool that interacts to the repository-service-tuf-api.

Component level

• repository_service_tuf package
  • Subpackages
    • repository_service_tuf.cli package
      • Subpackages
      • Module contents
    • repository_service_tuf.helpers package
      • Submodules
      • repository_service_tuf.helpers.api_client module
      • repository_service_tuf.helpers.cli module
      • Module contents
  • Module contents
• repository_service_tuf.cli package
  • Subpackages
    • repository_service_tuf.cli.admin package
      • Subpackages
      • Submodules
      • repository_service_tuf.cli.admin.ceremony module
      • repository_service_tuf.cli.admin.helpers module
      • repository_service_tuf.cli.admin.import_artifacts module
      • Module contents
    • repository_service_tuf.cli.artifact package
      • Submodules
      • repository_service_tuf.cli.artifact.add module
      • repository_service_tuf.cli.artifact.delete module
      • repository_service_tuf.cli.artifact.download module
      • repository_service_tuf.cli.artifact.repository module
      • Module contents
    • repository_service_tuf.cli.task package
      • Submodules
      • repository_service_tuf.cli.task.info module
      • Module contents
  • Module contents
• repository_service_tuf.cli.admin package
  • Subpackages
    • repository_service_tuf.cli.admin.delegations package
      • Submodules
      • repository_service_tuf.cli.admin.delegations.delete module
      • repository_service_tuf.cli.admin.delegations.new module
      • Module contents
    • repository_service_tuf.cli.admin.metadata package
      • Submodules
      • repository_service_tuf.cli.admin.metadata.sign module
      • repository_service_tuf.cli.admin.metadata.stop_sign module
      • repository_service_tuf.cli.admin.metadata.update module
      • Module contents
    • repository_service_tuf.cli.admin.send package
      • Submodules
      • repository_service_tuf.cli.admin.send.bootstrap module
      • repository_service_tuf.cli.admin.send.sign module
      • repository_service_tuf.cli.admin.send.update module
      • Module contents
  • Submodules
  • repository_service_tuf.cli.admin.ceremony module
  • repository_service_tuf.cli.admin.helpers module
    • BinsRole
      • BinsRole.number_of_delegated_bins
    • CeremonyPayload
      • CeremonyPayload.metadata
      • CeremonyPayload.settings
      • CeremonyPayload.timeout
    • DELEGATIONS_TYPE
      • DELEGATIONS_TYPE.BINS
      • DELEGATIONS_TYPE.CUSTOM_DELEGATIONS
      • DELEGATIONS_TYPE.values()
    • Metadatas
      • Metadatas.root
    • ONLINE_SIGNERS
      • ONLINE_SIGNERS.AWSKMS
      • ONLINE_SIGNERS.AZKMS
      • ONLINE_SIGNERS.GCPKMS
      • ONLINE_SIGNERS.HV
      • ONLINE_SIGNERS.KEY_PEM
    • ROOT_SIGNERS
      • ROOT_SIGNERS.HSM
      • ROOT_SIGNERS.KEY_PEM
      • ROOT_SIGNERS.SIGSTORE
    • Role
      • Role.expiration
    • Roles
      • Roles.bins
      • Roles.delegations
      • Roles.root
      • Roles.snapshot
      • Roles.targets
      • Roles.timestamp
    • SIGNERS
      • SIGNERS.names()
      • SIGNERS.values()
    • SIGSTORE_ISSUERS
      • SIGSTORE_ISSUERS.GitHub
      • SIGSTORE_ISSUERS.Google
      • SIGSTORE_ISSUERS.Microsoft
    • Settings
      • Settings.roles
    • SignPayload
      • SignPayload.role
      • SignPayload.signature
    • UpdatePayload
      • UpdatePayload.metadata
  • repository_service_tuf.cli.admin.import_artifacts module
  • Module contents
• repository_service_tuf.cli.admin.send package
  • Submodules
  • repository_service_tuf.cli.admin.send.bootstrap module
  • repository_service_tuf.cli.admin.send.sign module
  • repository_service_tuf.cli.admin.send.update module
  • Module contents
• repository_service_tuf.cli.artifact package
  • Submodules
  • repository_service_tuf.cli.artifact.add module
  • repository_service_tuf.cli.artifact.delete module
  • repository_service_tuf.cli.artifact.download module
  • repository_service_tuf.cli.artifact.repository module
    • write_config()
  • Module contents
• repository_service_tuf.helpers package
  • Submodules
  • repository_service_tuf.helpers.api_client module
    • Methods
      • Methods.DELETE
      • Methods.GET
      • Methods.POST
    • URL
      • URL.ARTIFACTS
      • URL.ARTIFACTS_DELETE
      • URL.BOOTSTRAP
      • URL.CONFIG
      • URL.DELEGATIONS
      • URL.DELEGATIONS_DELETE
      • URL.METADATA
      • URL.METADATA_SIGN
      • URL.METADATA_SIGN_DELETE
      • URL.PUBLISH_ARTIFACTS
      • URL.TASK
    • bootstrap_status()
    • get_task()
    • publish_artifacts()
    • request_server()
    • send_payload()
    • task_status()
  • repository_service_tuf.helpers.cli module
    • AddPayload
      • AddPayload.add_task_id_to_custom
      • AddPayload.artifacts
      • AddPayload.publish_artifacts
      • AddPayload.to_dict()
    • Artifact
      • Artifact.info
      • Artifact.path
    • ArtifactInfo
      • ArtifactInfo.custom
      • ArtifactInfo.hashes
      • ArtifactInfo.length
    • DeletePayload
      • DeletePayload.artifacts
      • DeletePayload.to_dict()
    • PayloadArtifactsHashes
      • PayloadArtifactsHashes.blake2b_256
    • calculate_blake2b_256()
    • create_artifact_add_payload_from_filepath()
    • create_artifact_delete_payload_from_filepath()
  • Module contents
• repository_service_tuf
  • repository_service_tuf package
    • Subpackages
      • repository_service_tuf.cli package
      • repository_service_tuf.helpers package
    • Module contents